| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Network.AWS.StorageGateway
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- CancelArchival
- CreateStorediSCSIVolume
- DescribeFileSystemAssociations
- CreateNFSFileShare
- AssociateFileSystem
- DetachVolume
- DescribeChapCredentials
- SetLocalConsolePassword
- CreateTapes
- UpdateVTLDeviceType
- CreateCachediSCSIVolume
- ListFileShares (Paginated)
- JoinDomain
- DeleteFileShare
- ListVolumeInitiators
- AddUploadBuffer
- ListTagsForResource (Paginated)
- NotifyWhenUploaded
- ListTapePools (Paginated)
- DeleteTapePool
- UpdateGatewayInformation
- DescribeMaintenanceStartTime
- AssignTapePool
- DescribeWorkingStorage
- DescribeCachediSCSIVolumes
- AddCache
- CreateTapePool
- StartGateway
- ShutdownGateway
- ListAutomaticTapeCreationPolicies
- UpdateGatewaySoftwareNow
- RemoveTagsFromResource
- UpdateFileSystemAssociation
- CreateSMBFileShare
- DeleteChapCredentials
- UpdateChapCredentials
- AttachVolume
- DescribeAvailabilityMonitorTest
- DescribeUploadBuffer
- DescribeTapes (Paginated)
- DescribeStorediSCSIVolumes
- DisassociateFileSystem
- SetSMBGuestPassword
- CreateSnapshotFromVolumeRecoveryPoint
- RetrieveTapeRecoveryPoint
- AddTagsToResource
- DeleteGateway
- UpdateMaintenanceStartTime
- DescribeGatewayInformation
- RefreshCache
- UpdateNFSFileShare
- RetrieveTapeArchive
- DescribeTapeArchives (Paginated)
- UpdateBandwidthRateLimitSchedule
- DisableGateway
- DescribeSMBSettings
- DescribeSnapshotSchedule
- CreateTapeWithBarcode
- DescribeBandwidthRateLimit
- DeleteAutomaticTapeCreationPolicy
- UpdateAutomaticTapeCreationPolicy
- UpdateSMBFileShareVisibility
- DeleteSnapshotSchedule
- UpdateSnapshotSchedule
- DescribeBandwidthRateLimitSchedule
- CreateSnapshot
- UpdateSMBSecurityStrategy
- CancelRetrieval
- DescribeVTLDevices (Paginated)
- StartAvailabilityMonitorTest
- DeleteTapeArchive
- ListFileSystemAssociations (Paginated)
- UpdateSMBFileShare
- DescribeNFSFileShares
- ListVolumeRecoveryPoints
- ListTapes (Paginated)
- ResetCache
- DescribeSMBFileShares
- ListGateways (Paginated)
- DeleteTape
- ListLocalDisks
- ListVolumes (Paginated)
- UpdateBandwidthRateLimit
- AddWorkingStorage
- DescribeTapeRecoveryPoints (Paginated)
- DeleteBandwidthRateLimit
- ActivateGateway
- DescribeCache
- DeleteVolume
- Types
- ActiveDirectoryStatus
- AvailabilityMonitorTestStatus
- CaseSensitivity
- FileShareType
- GatewayCapacity
- HostEnvironment
- ObjectACL
- PoolStatus
- RetentionLockType
- SMBSecurityStrategy
- TapeStorageClass
- AutomaticTapeCreationPolicyInfo
- AutomaticTapeCreationRule
- BandwidthRateLimitInterval
- CacheAttributes
- CachediSCSIVolume
- ChapInfo
- DeviceiSCSIAttributes
- Disk
- EndpointNetworkConfiguration
- FileShareInfo
- FileSystemAssociationInfo
- FileSystemAssociationSummary
- GatewayInfo
- NFSFileShareDefaults
- NFSFileShareInfo
- NetworkInterface
- PoolInfo
- SMBFileShareInfo
- StorediSCSIVolume
- Tag
- Tape
- TapeArchive
- TapeInfo
- TapeRecoveryPointInfo
- VTLDevice
- VolumeInfo
- VolumeRecoveryPointInfo
- VolumeiSCSIAttributes
Description
Derived from API version 2013-06-30 of the AWS service descriptions, licensed under Apache 2.0.
Storage Gateway Service
Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the Amazon Web Services storage infrastructure. The service enables you to securely upload data to the Cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the /Storage Gateway Service API Reference/:
- Storage Gateway required request headers: Describes the required headers that you must send with every POST request to Storage Gateway.
- Signing requests: Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
- Error responses: Provides reference information about Storage Gateway errors.
- Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
- Storage Gateway endpoints and quotas: Provides a list of each Region and the endpoints available for use with Storage Gateway.
Storage Gateway resource IDs are in uppercase. When you use these
resource IDs with the Amazon EC2 API, EC2 expects resource IDs in
lowercase. You must change your resource ID to lowercase to use it with
the EC2 API. For example, in Storage Gateway the ID for a volume might
be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you
must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might
not behave as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS resource IDs.
For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:
arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following:
snap-78e226633445566ee.
For more information, see Announcement: Heads-up – Longer Storage Gateway volume and snapshot IDs coming in 2016.
Synopsis
- defaultService :: Service
- _InvalidGatewayRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableError :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError
- data CancelArchival = CancelArchival' Text Text
- newCancelArchival :: Text -> Text -> CancelArchival
- data CancelArchivalResponse = CancelArchivalResponse' (Maybe Text) Int
- newCancelArchivalResponse :: Int -> CancelArchivalResponse
- data CreateStorediSCSIVolume = CreateStorediSCSIVolume' (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe Text) Text Text Bool Text Text
- newCreateStorediSCSIVolume :: Text -> Text -> Bool -> Text -> Text -> CreateStorediSCSIVolume
- data CreateStorediSCSIVolumeResponse = CreateStorediSCSIVolumeResponse' (Maybe Text) (Maybe Text) (Maybe Integer) Int
- newCreateStorediSCSIVolumeResponse :: Int -> CreateStorediSCSIVolumeResponse
- data DescribeFileSystemAssociations = DescribeFileSystemAssociations' (NonEmpty Text)
- newDescribeFileSystemAssociations :: NonEmpty Text -> DescribeFileSystemAssociations
- data DescribeFileSystemAssociationsResponse = DescribeFileSystemAssociationsResponse' (Maybe [FileSystemAssociationInfo]) Int
- newDescribeFileSystemAssociationsResponse :: Int -> DescribeFileSystemAssociationsResponse
- data CreateNFSFileShare = CreateNFSFileShare' (Maybe Text) (Maybe Text) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NFSFileShareDefaults) (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Tag]) Text Text Text Text
- newCreateNFSFileShare :: Text -> Text -> Text -> Text -> CreateNFSFileShare
- data CreateNFSFileShareResponse = CreateNFSFileShareResponse' (Maybe Text) Int
- newCreateNFSFileShareResponse :: Int -> CreateNFSFileShareResponse
- data AssociateFileSystem = AssociateFileSystem' (Maybe Text) (Maybe CacheAttributes) (Maybe EndpointNetworkConfiguration) (Maybe [Tag]) Text (Sensitive Text) Text Text Text
- newAssociateFileSystem :: Text -> Text -> Text -> Text -> Text -> AssociateFileSystem
- data AssociateFileSystemResponse = AssociateFileSystemResponse' (Maybe Text) Int
- newAssociateFileSystemResponse :: Int -> AssociateFileSystemResponse
- data DetachVolume = DetachVolume' (Maybe Bool) Text
- newDetachVolume :: Text -> DetachVolume
- data DetachVolumeResponse = DetachVolumeResponse' (Maybe Text) Int
- newDetachVolumeResponse :: Int -> DetachVolumeResponse
- data DescribeChapCredentials = DescribeChapCredentials' Text
- newDescribeChapCredentials :: Text -> DescribeChapCredentials
- data DescribeChapCredentialsResponse = DescribeChapCredentialsResponse' (Maybe [ChapInfo]) Int
- newDescribeChapCredentialsResponse :: Int -> DescribeChapCredentialsResponse
- data SetLocalConsolePassword = SetLocalConsolePassword' Text (Sensitive Text)
- newSetLocalConsolePassword :: Text -> Text -> SetLocalConsolePassword
- data SetLocalConsolePasswordResponse = SetLocalConsolePasswordResponse' (Maybe Text) Int
- newSetLocalConsolePasswordResponse :: Int -> SetLocalConsolePasswordResponse
- data CreateTapes = CreateTapes' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe [Tag]) Text Integer Text Natural Text
- newCreateTapes :: Text -> Integer -> Text -> Natural -> Text -> CreateTapes
- data CreateTapesResponse = CreateTapesResponse' (Maybe [Text]) Int
- newCreateTapesResponse :: Int -> CreateTapesResponse
- data UpdateVTLDeviceType = UpdateVTLDeviceType' Text Text
- newUpdateVTLDeviceType :: Text -> Text -> UpdateVTLDeviceType
- data UpdateVTLDeviceTypeResponse = UpdateVTLDeviceTypeResponse' (Maybe Text) Int
- newUpdateVTLDeviceTypeResponse :: Int -> UpdateVTLDeviceTypeResponse
- data CreateCachediSCSIVolume = CreateCachediSCSIVolume' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe Text) Text Integer Text Text Text
- newCreateCachediSCSIVolume :: Text -> Integer -> Text -> Text -> Text -> CreateCachediSCSIVolume
- data CreateCachediSCSIVolumeResponse = CreateCachediSCSIVolumeResponse' (Maybe Text) (Maybe Text) Int
- newCreateCachediSCSIVolumeResponse :: Int -> CreateCachediSCSIVolumeResponse
- data ListFileShares = ListFileShares' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListFileShares :: ListFileShares
- data ListFileSharesResponse = ListFileSharesResponse' (Maybe [FileShareInfo]) (Maybe Text) (Maybe Text) Int
- newListFileSharesResponse :: Int -> ListFileSharesResponse
- data JoinDomain = JoinDomain' (Maybe Text) (Maybe Natural) (Maybe [Text]) Text Text Text (Sensitive Text)
- newJoinDomain :: Text -> Text -> Text -> Text -> JoinDomain
- data JoinDomainResponse = JoinDomainResponse' (Maybe Text) (Maybe ActiveDirectoryStatus) Int
- newJoinDomainResponse :: Int -> JoinDomainResponse
- data DeleteFileShare = DeleteFileShare' (Maybe Bool) Text
- newDeleteFileShare :: Text -> DeleteFileShare
- data DeleteFileShareResponse = DeleteFileShareResponse' (Maybe Text) Int
- newDeleteFileShareResponse :: Int -> DeleteFileShareResponse
- data ListVolumeInitiators = ListVolumeInitiators' Text
- newListVolumeInitiators :: Text -> ListVolumeInitiators
- data ListVolumeInitiatorsResponse = ListVolumeInitiatorsResponse' (Maybe [Text]) Int
- newListVolumeInitiatorsResponse :: Int -> ListVolumeInitiatorsResponse
- data AddUploadBuffer = AddUploadBuffer' Text [Text]
- newAddUploadBuffer :: Text -> AddUploadBuffer
- data AddUploadBufferResponse = AddUploadBufferResponse' (Maybe Text) Int
- newAddUploadBufferResponse :: Int -> AddUploadBufferResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Text) (Maybe Natural) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data NotifyWhenUploaded = NotifyWhenUploaded' Text
- newNotifyWhenUploaded :: Text -> NotifyWhenUploaded
- data NotifyWhenUploadedResponse = NotifyWhenUploadedResponse' (Maybe Text) (Maybe Text) Int
- newNotifyWhenUploadedResponse :: Int -> NotifyWhenUploadedResponse
- data ListTapePools = ListTapePools' (Maybe [Text]) (Maybe Text) (Maybe Natural)
- newListTapePools :: ListTapePools
- data ListTapePoolsResponse = ListTapePoolsResponse' (Maybe [PoolInfo]) (Maybe Text) Int
- newListTapePoolsResponse :: Int -> ListTapePoolsResponse
- data DeleteTapePool = DeleteTapePool' Text
- newDeleteTapePool :: Text -> DeleteTapePool
- data DeleteTapePoolResponse = DeleteTapePoolResponse' (Maybe Text) Int
- newDeleteTapePoolResponse :: Int -> DeleteTapePoolResponse
- data UpdateGatewayInformation = UpdateGatewayInformation' (Maybe GatewayCapacity) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newUpdateGatewayInformation :: Text -> UpdateGatewayInformation
- data UpdateGatewayInformationResponse = UpdateGatewayInformationResponse' (Maybe Text) (Maybe Text) Int
- newUpdateGatewayInformationResponse :: Int -> UpdateGatewayInformationResponse
- data DescribeMaintenanceStartTime = DescribeMaintenanceStartTime' Text
- newDescribeMaintenanceStartTime :: Text -> DescribeMaintenanceStartTime
- data DescribeMaintenanceStartTimeResponse = DescribeMaintenanceStartTimeResponse' (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Natural) Int
- newDescribeMaintenanceStartTimeResponse :: Int -> DescribeMaintenanceStartTimeResponse
- data AssignTapePool = AssignTapePool' (Maybe Bool) Text Text
- newAssignTapePool :: Text -> Text -> AssignTapePool
- data AssignTapePoolResponse = AssignTapePoolResponse' (Maybe Text) Int
- newAssignTapePoolResponse :: Int -> AssignTapePoolResponse
- data DescribeWorkingStorage = DescribeWorkingStorage' Text
- newDescribeWorkingStorage :: Text -> DescribeWorkingStorage
- data DescribeWorkingStorageResponse = DescribeWorkingStorageResponse' (Maybe Text) (Maybe [Text]) (Maybe Integer) (Maybe Integer) Int
- newDescribeWorkingStorageResponse :: Int -> DescribeWorkingStorageResponse
- data DescribeCachediSCSIVolumes = DescribeCachediSCSIVolumes' [Text]
- newDescribeCachediSCSIVolumes :: DescribeCachediSCSIVolumes
- data DescribeCachediSCSIVolumesResponse = DescribeCachediSCSIVolumesResponse' (Maybe [CachediSCSIVolume]) Int
- newDescribeCachediSCSIVolumesResponse :: Int -> DescribeCachediSCSIVolumesResponse
- data AddCache = AddCache' Text [Text]
- newAddCache :: Text -> AddCache
- data AddCacheResponse = AddCacheResponse' (Maybe Text) Int
- newAddCacheResponse :: Int -> AddCacheResponse
- data CreateTapePool = CreateTapePool' (Maybe RetentionLockType) (Maybe Natural) (Maybe [Tag]) Text TapeStorageClass
- newCreateTapePool :: Text -> TapeStorageClass -> CreateTapePool
- data CreateTapePoolResponse = CreateTapePoolResponse' (Maybe Text) Int
- newCreateTapePoolResponse :: Int -> CreateTapePoolResponse
- data StartGateway = StartGateway' Text
- newStartGateway :: Text -> StartGateway
- data StartGatewayResponse = StartGatewayResponse' (Maybe Text) Int
- newStartGatewayResponse :: Int -> StartGatewayResponse
- data ShutdownGateway = ShutdownGateway' Text
- newShutdownGateway :: Text -> ShutdownGateway
- data ShutdownGatewayResponse = ShutdownGatewayResponse' (Maybe Text) Int
- newShutdownGatewayResponse :: Int -> ShutdownGatewayResponse
- data ListAutomaticTapeCreationPolicies = ListAutomaticTapeCreationPolicies' (Maybe Text)
- newListAutomaticTapeCreationPolicies :: ListAutomaticTapeCreationPolicies
- data ListAutomaticTapeCreationPoliciesResponse = ListAutomaticTapeCreationPoliciesResponse' (Maybe [AutomaticTapeCreationPolicyInfo]) Int
- newListAutomaticTapeCreationPoliciesResponse :: Int -> ListAutomaticTapeCreationPoliciesResponse
- data UpdateGatewaySoftwareNow = UpdateGatewaySoftwareNow' Text
- newUpdateGatewaySoftwareNow :: Text -> UpdateGatewaySoftwareNow
- data UpdateGatewaySoftwareNowResponse = UpdateGatewaySoftwareNowResponse' (Maybe Text) Int
- newUpdateGatewaySoftwareNowResponse :: Int -> UpdateGatewaySoftwareNowResponse
- data RemoveTagsFromResource = RemoveTagsFromResource' Text [Text]
- newRemoveTagsFromResource :: Text -> RemoveTagsFromResource
- data RemoveTagsFromResourceResponse = RemoveTagsFromResourceResponse' (Maybe Text) Int
- newRemoveTagsFromResourceResponse :: Int -> RemoveTagsFromResourceResponse
- data UpdateFileSystemAssociation = UpdateFileSystemAssociation' (Maybe Text) (Maybe CacheAttributes) (Maybe Text) (Maybe (Sensitive Text)) Text
- newUpdateFileSystemAssociation :: Text -> UpdateFileSystemAssociation
- data UpdateFileSystemAssociationResponse = UpdateFileSystemAssociationResponse' (Maybe Text) Int
- newUpdateFileSystemAssociationResponse :: Int -> UpdateFileSystemAssociationResponse
- data CreateSMBFileShare = CreateSMBFileShare' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe CaseSensitivity) (Maybe [Tag]) Text Text Text Text
- newCreateSMBFileShare :: Text -> Text -> Text -> Text -> CreateSMBFileShare
- data CreateSMBFileShareResponse = CreateSMBFileShareResponse' (Maybe Text) Int
- newCreateSMBFileShareResponse :: Int -> CreateSMBFileShareResponse
- data DeleteChapCredentials = DeleteChapCredentials' Text Text
- newDeleteChapCredentials :: Text -> Text -> DeleteChapCredentials
- data DeleteChapCredentialsResponse = DeleteChapCredentialsResponse' (Maybe Text) (Maybe Text) Int
- newDeleteChapCredentialsResponse :: Int -> DeleteChapCredentialsResponse
- data UpdateChapCredentials = UpdateChapCredentials' (Maybe (Sensitive Text)) Text (Sensitive Text) Text
- newUpdateChapCredentials :: Text -> Text -> Text -> UpdateChapCredentials
- data UpdateChapCredentialsResponse = UpdateChapCredentialsResponse' (Maybe Text) (Maybe Text) Int
- newUpdateChapCredentialsResponse :: Int -> UpdateChapCredentialsResponse
- data AttachVolume = AttachVolume' (Maybe Text) (Maybe Text) Text Text Text
- newAttachVolume :: Text -> Text -> Text -> AttachVolume
- data AttachVolumeResponse = AttachVolumeResponse' (Maybe Text) (Maybe Text) Int
- newAttachVolumeResponse :: Int -> AttachVolumeResponse
- data DescribeAvailabilityMonitorTest = DescribeAvailabilityMonitorTest' Text
- newDescribeAvailabilityMonitorTest :: Text -> DescribeAvailabilityMonitorTest
- data DescribeAvailabilityMonitorTestResponse = DescribeAvailabilityMonitorTestResponse' (Maybe AvailabilityMonitorTestStatus) (Maybe POSIX) (Maybe Text) Int
- newDescribeAvailabilityMonitorTestResponse :: Int -> DescribeAvailabilityMonitorTestResponse
- data DescribeUploadBuffer = DescribeUploadBuffer' Text
- newDescribeUploadBuffer :: Text -> DescribeUploadBuffer
- data DescribeUploadBufferResponse = DescribeUploadBufferResponse' (Maybe Integer) (Maybe Text) (Maybe [Text]) (Maybe Integer) Int
- newDescribeUploadBufferResponse :: Int -> DescribeUploadBufferResponse
- data DescribeTapes = DescribeTapes' (Maybe Text) (Maybe Natural) (Maybe [Text]) Text
- newDescribeTapes :: Text -> DescribeTapes
- data DescribeTapesResponse = DescribeTapesResponse' (Maybe Text) (Maybe [Tape]) Int
- newDescribeTapesResponse :: Int -> DescribeTapesResponse
- data DescribeStorediSCSIVolumes = DescribeStorediSCSIVolumes' [Text]
- newDescribeStorediSCSIVolumes :: DescribeStorediSCSIVolumes
- data DescribeStorediSCSIVolumesResponse = DescribeStorediSCSIVolumesResponse' (Maybe [StorediSCSIVolume]) Int
- newDescribeStorediSCSIVolumesResponse :: Int -> DescribeStorediSCSIVolumesResponse
- data DisassociateFileSystem = DisassociateFileSystem' (Maybe Bool) Text
- newDisassociateFileSystem :: Text -> DisassociateFileSystem
- data DisassociateFileSystemResponse = DisassociateFileSystemResponse' (Maybe Text) Int
- newDisassociateFileSystemResponse :: Int -> DisassociateFileSystemResponse
- data SetSMBGuestPassword = SetSMBGuestPassword' Text (Sensitive Text)
- newSetSMBGuestPassword :: Text -> Text -> SetSMBGuestPassword
- data SetSMBGuestPasswordResponse = SetSMBGuestPasswordResponse' (Maybe Text) Int
- newSetSMBGuestPasswordResponse :: Int -> SetSMBGuestPasswordResponse
- data CreateSnapshotFromVolumeRecoveryPoint = CreateSnapshotFromVolumeRecoveryPoint' (Maybe [Tag]) Text Text
- newCreateSnapshotFromVolumeRecoveryPoint :: Text -> Text -> CreateSnapshotFromVolumeRecoveryPoint
- data CreateSnapshotFromVolumeRecoveryPointResponse = CreateSnapshotFromVolumeRecoveryPointResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateSnapshotFromVolumeRecoveryPointResponse :: Int -> CreateSnapshotFromVolumeRecoveryPointResponse
- data RetrieveTapeRecoveryPoint = RetrieveTapeRecoveryPoint' Text Text
- newRetrieveTapeRecoveryPoint :: Text -> Text -> RetrieveTapeRecoveryPoint
- data RetrieveTapeRecoveryPointResponse = RetrieveTapeRecoveryPointResponse' (Maybe Text) Int
- newRetrieveTapeRecoveryPointResponse :: Int -> RetrieveTapeRecoveryPointResponse
- data AddTagsToResource = AddTagsToResource' Text [Tag]
- newAddTagsToResource :: Text -> AddTagsToResource
- data AddTagsToResourceResponse = AddTagsToResourceResponse' (Maybe Text) Int
- newAddTagsToResourceResponse :: Int -> AddTagsToResourceResponse
- data DeleteGateway = DeleteGateway' Text
- newDeleteGateway :: Text -> DeleteGateway
- data DeleteGatewayResponse = DeleteGatewayResponse' (Maybe Text) Int
- newDeleteGatewayResponse :: Int -> DeleteGatewayResponse
- data UpdateMaintenanceStartTime = UpdateMaintenanceStartTime' (Maybe Natural) (Maybe Natural) Text Natural Natural
- newUpdateMaintenanceStartTime :: Text -> Natural -> Natural -> UpdateMaintenanceStartTime
- data UpdateMaintenanceStartTimeResponse = UpdateMaintenanceStartTimeResponse' (Maybe Text) Int
- newUpdateMaintenanceStartTimeResponse :: Int -> UpdateMaintenanceStartTimeResponse
- data DescribeGatewayInformation = DescribeGatewayInformation' Text
- newDescribeGatewayInformation :: Text -> DescribeGatewayInformation
- data DescribeGatewayInformationResponse = DescribeGatewayInformationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [NetworkInterface]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe GatewayCapacity) (Maybe [GatewayCapacity]) (Maybe Text) (Maybe Text) (Maybe HostEnvironment) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Int
- newDescribeGatewayInformationResponse :: Int -> DescribeGatewayInformationResponse
- data RefreshCache = RefreshCache' (Maybe (NonEmpty Text)) (Maybe Bool) Text
- newRefreshCache :: Text -> RefreshCache
- data RefreshCacheResponse = RefreshCacheResponse' (Maybe Text) (Maybe Text) Int
- newRefreshCacheResponse :: Int -> RefreshCacheResponse
- data UpdateNFSFileShare = UpdateNFSFileShare' (Maybe Text) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NFSFileShareDefaults) (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe Bool) Text
- newUpdateNFSFileShare :: Text -> UpdateNFSFileShare
- data UpdateNFSFileShareResponse = UpdateNFSFileShareResponse' (Maybe Text) Int
- newUpdateNFSFileShareResponse :: Int -> UpdateNFSFileShareResponse
- data RetrieveTapeArchive = RetrieveTapeArchive' Text Text
- newRetrieveTapeArchive :: Text -> Text -> RetrieveTapeArchive
- data RetrieveTapeArchiveResponse = RetrieveTapeArchiveResponse' (Maybe Text) Int
- newRetrieveTapeArchiveResponse :: Int -> RetrieveTapeArchiveResponse
- data DescribeTapeArchives = DescribeTapeArchives' (Maybe Text) (Maybe Natural) (Maybe [Text])
- newDescribeTapeArchives :: DescribeTapeArchives
- data DescribeTapeArchivesResponse = DescribeTapeArchivesResponse' (Maybe [TapeArchive]) (Maybe Text) Int
- newDescribeTapeArchivesResponse :: Int -> DescribeTapeArchivesResponse
- data UpdateBandwidthRateLimitSchedule = UpdateBandwidthRateLimitSchedule' Text [BandwidthRateLimitInterval]
- newUpdateBandwidthRateLimitSchedule :: Text -> UpdateBandwidthRateLimitSchedule
- data UpdateBandwidthRateLimitScheduleResponse = UpdateBandwidthRateLimitScheduleResponse' (Maybe Text) Int
- newUpdateBandwidthRateLimitScheduleResponse :: Int -> UpdateBandwidthRateLimitScheduleResponse
- data DisableGateway = DisableGateway' Text
- newDisableGateway :: Text -> DisableGateway
- data DisableGatewayResponse = DisableGatewayResponse' (Maybe Text) Int
- newDisableGatewayResponse :: Int -> DisableGatewayResponse
- data DescribeSMBSettings = DescribeSMBSettings' Text
- newDescribeSMBSettings :: Text -> DescribeSMBSettings
- data DescribeSMBSettingsResponse = DescribeSMBSettingsResponse' (Maybe Text) (Maybe Bool) (Maybe ActiveDirectoryStatus) (Maybe Text) (Maybe Bool) (Maybe SMBSecurityStrategy) Int
- newDescribeSMBSettingsResponse :: Int -> DescribeSMBSettingsResponse
- data DescribeSnapshotSchedule = DescribeSnapshotSchedule' Text
- newDescribeSnapshotSchedule :: Text -> DescribeSnapshotSchedule
- data DescribeSnapshotScheduleResponse = DescribeSnapshotScheduleResponse' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe [Tag]) Int
- newDescribeSnapshotScheduleResponse :: Int -> DescribeSnapshotScheduleResponse
- data CreateTapeWithBarcode = CreateTapeWithBarcode' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe [Tag]) Text Integer Text
- newCreateTapeWithBarcode :: Text -> Integer -> Text -> CreateTapeWithBarcode
- data CreateTapeWithBarcodeResponse = CreateTapeWithBarcodeResponse' (Maybe Text) Int
- newCreateTapeWithBarcodeResponse :: Int -> CreateTapeWithBarcodeResponse
- data DescribeBandwidthRateLimit = DescribeBandwidthRateLimit' Text
- newDescribeBandwidthRateLimit :: Text -> DescribeBandwidthRateLimit
- data DescribeBandwidthRateLimitResponse = DescribeBandwidthRateLimitResponse' (Maybe Text) (Maybe Natural) (Maybe Natural) Int
- newDescribeBandwidthRateLimitResponse :: Int -> DescribeBandwidthRateLimitResponse
- data DeleteAutomaticTapeCreationPolicy = DeleteAutomaticTapeCreationPolicy' Text
- newDeleteAutomaticTapeCreationPolicy :: Text -> DeleteAutomaticTapeCreationPolicy
- data DeleteAutomaticTapeCreationPolicyResponse = DeleteAutomaticTapeCreationPolicyResponse' (Maybe Text) Int
- newDeleteAutomaticTapeCreationPolicyResponse :: Int -> DeleteAutomaticTapeCreationPolicyResponse
- data UpdateAutomaticTapeCreationPolicy = UpdateAutomaticTapeCreationPolicy' (NonEmpty AutomaticTapeCreationRule) Text
- newUpdateAutomaticTapeCreationPolicy :: NonEmpty AutomaticTapeCreationRule -> Text -> UpdateAutomaticTapeCreationPolicy
- data UpdateAutomaticTapeCreationPolicyResponse = UpdateAutomaticTapeCreationPolicyResponse' (Maybe Text) Int
- newUpdateAutomaticTapeCreationPolicyResponse :: Int -> UpdateAutomaticTapeCreationPolicyResponse
- data UpdateSMBFileShareVisibility = UpdateSMBFileShareVisibility' Text Bool
- newUpdateSMBFileShareVisibility :: Text -> Bool -> UpdateSMBFileShareVisibility
- data UpdateSMBFileShareVisibilityResponse = UpdateSMBFileShareVisibilityResponse' (Maybe Text) Int
- newUpdateSMBFileShareVisibilityResponse :: Int -> UpdateSMBFileShareVisibilityResponse
- data DeleteSnapshotSchedule = DeleteSnapshotSchedule' Text
- newDeleteSnapshotSchedule :: Text -> DeleteSnapshotSchedule
- data DeleteSnapshotScheduleResponse = DeleteSnapshotScheduleResponse' (Maybe Text) Int
- newDeleteSnapshotScheduleResponse :: Int -> DeleteSnapshotScheduleResponse
- data UpdateSnapshotSchedule = UpdateSnapshotSchedule' (Maybe Text) (Maybe [Tag]) Text Natural Natural
- newUpdateSnapshotSchedule :: Text -> Natural -> Natural -> UpdateSnapshotSchedule
- data UpdateSnapshotScheduleResponse = UpdateSnapshotScheduleResponse' (Maybe Text) Int
- newUpdateSnapshotScheduleResponse :: Int -> UpdateSnapshotScheduleResponse
- data DescribeBandwidthRateLimitSchedule = DescribeBandwidthRateLimitSchedule' Text
- newDescribeBandwidthRateLimitSchedule :: Text -> DescribeBandwidthRateLimitSchedule
- data DescribeBandwidthRateLimitScheduleResponse = DescribeBandwidthRateLimitScheduleResponse' (Maybe Text) (Maybe [BandwidthRateLimitInterval]) Int
- newDescribeBandwidthRateLimitScheduleResponse :: Int -> DescribeBandwidthRateLimitScheduleResponse
- data CreateSnapshot = CreateSnapshot' (Maybe [Tag]) Text Text
- newCreateSnapshot :: Text -> Text -> CreateSnapshot
- data CreateSnapshotResponse = CreateSnapshotResponse' (Maybe Text) (Maybe Text) Int
- newCreateSnapshotResponse :: Int -> CreateSnapshotResponse
- data UpdateSMBSecurityStrategy = UpdateSMBSecurityStrategy' Text SMBSecurityStrategy
- newUpdateSMBSecurityStrategy :: Text -> SMBSecurityStrategy -> UpdateSMBSecurityStrategy
- data UpdateSMBSecurityStrategyResponse = UpdateSMBSecurityStrategyResponse' (Maybe Text) Int
- newUpdateSMBSecurityStrategyResponse :: Int -> UpdateSMBSecurityStrategyResponse
- data CancelRetrieval = CancelRetrieval' Text Text
- newCancelRetrieval :: Text -> Text -> CancelRetrieval
- data CancelRetrievalResponse = CancelRetrievalResponse' (Maybe Text) Int
- newCancelRetrievalResponse :: Int -> CancelRetrievalResponse
- data DescribeVTLDevices = DescribeVTLDevices' (Maybe Text) (Maybe Natural) (Maybe [Text]) Text
- newDescribeVTLDevices :: Text -> DescribeVTLDevices
- data DescribeVTLDevicesResponse = DescribeVTLDevicesResponse' (Maybe [VTLDevice]) (Maybe Text) (Maybe Text) Int
- newDescribeVTLDevicesResponse :: Int -> DescribeVTLDevicesResponse
- data StartAvailabilityMonitorTest = StartAvailabilityMonitorTest' Text
- newStartAvailabilityMonitorTest :: Text -> StartAvailabilityMonitorTest
- data StartAvailabilityMonitorTestResponse = StartAvailabilityMonitorTestResponse' (Maybe Text) Int
- newStartAvailabilityMonitorTestResponse :: Int -> StartAvailabilityMonitorTestResponse
- data DeleteTapeArchive = DeleteTapeArchive' (Maybe Bool) Text
- newDeleteTapeArchive :: Text -> DeleteTapeArchive
- data DeleteTapeArchiveResponse = DeleteTapeArchiveResponse' (Maybe Text) Int
- newDeleteTapeArchiveResponse :: Int -> DeleteTapeArchiveResponse
- data ListFileSystemAssociations = ListFileSystemAssociations' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListFileSystemAssociations :: ListFileSystemAssociations
- data ListFileSystemAssociationsResponse = ListFileSystemAssociationsResponse' (Maybe [FileSystemAssociationSummary]) (Maybe Text) (Maybe Text) Int
- newListFileSystemAssociationsResponse :: Int -> ListFileSystemAssociationsResponse
- data UpdateSMBFileShare = UpdateSMBFileShare' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe CaseSensitivity) Text
- newUpdateSMBFileShare :: Text -> UpdateSMBFileShare
- data UpdateSMBFileShareResponse = UpdateSMBFileShareResponse' (Maybe Text) Int
- newUpdateSMBFileShareResponse :: Int -> UpdateSMBFileShareResponse
- data DescribeNFSFileShares = DescribeNFSFileShares' (NonEmpty Text)
- newDescribeNFSFileShares :: NonEmpty Text -> DescribeNFSFileShares
- data DescribeNFSFileSharesResponse = DescribeNFSFileSharesResponse' (Maybe [NFSFileShareInfo]) Int
- newDescribeNFSFileSharesResponse :: Int -> DescribeNFSFileSharesResponse
- data ListVolumeRecoveryPoints = ListVolumeRecoveryPoints' Text
- newListVolumeRecoveryPoints :: Text -> ListVolumeRecoveryPoints
- data ListVolumeRecoveryPointsResponse = ListVolumeRecoveryPointsResponse' (Maybe [VolumeRecoveryPointInfo]) (Maybe Text) Int
- newListVolumeRecoveryPointsResponse :: Int -> ListVolumeRecoveryPointsResponse
- data ListTapes = ListTapes' (Maybe Text) (Maybe Natural) (Maybe [Text])
- newListTapes :: ListTapes
- data ListTapesResponse = ListTapesResponse' (Maybe Text) (Maybe [TapeInfo]) Int
- newListTapesResponse :: Int -> ListTapesResponse
- data ResetCache = ResetCache' Text
- newResetCache :: Text -> ResetCache
- data ResetCacheResponse = ResetCacheResponse' (Maybe Text) Int
- newResetCacheResponse :: Int -> ResetCacheResponse
- data DescribeSMBFileShares = DescribeSMBFileShares' (NonEmpty Text)
- newDescribeSMBFileShares :: NonEmpty Text -> DescribeSMBFileShares
- data DescribeSMBFileSharesResponse = DescribeSMBFileSharesResponse' (Maybe [SMBFileShareInfo]) Int
- newDescribeSMBFileSharesResponse :: Int -> DescribeSMBFileSharesResponse
- data ListGateways = ListGateways' (Maybe Text) (Maybe Natural)
- newListGateways :: ListGateways
- data ListGatewaysResponse = ListGatewaysResponse' (Maybe Text) (Maybe [GatewayInfo]) Int
- newListGatewaysResponse :: Int -> ListGatewaysResponse
- data DeleteTape = DeleteTape' (Maybe Bool) Text Text
- newDeleteTape :: Text -> Text -> DeleteTape
- data DeleteTapeResponse = DeleteTapeResponse' (Maybe Text) Int
- newDeleteTapeResponse :: Int -> DeleteTapeResponse
- data ListLocalDisks = ListLocalDisks' Text
- newListLocalDisks :: Text -> ListLocalDisks
- data ListLocalDisksResponse = ListLocalDisksResponse' (Maybe Text) (Maybe [Disk]) Int
- newListLocalDisksResponse :: Int -> ListLocalDisksResponse
- data ListVolumes = ListVolumes' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListVolumes :: ListVolumes
- data ListVolumesResponse = ListVolumesResponse' (Maybe Text) (Maybe Text) (Maybe [VolumeInfo]) Int
- newListVolumesResponse :: Int -> ListVolumesResponse
- data UpdateBandwidthRateLimit = UpdateBandwidthRateLimit' (Maybe Natural) (Maybe Natural) Text
- newUpdateBandwidthRateLimit :: Text -> UpdateBandwidthRateLimit
- data UpdateBandwidthRateLimitResponse = UpdateBandwidthRateLimitResponse' (Maybe Text) Int
- newUpdateBandwidthRateLimitResponse :: Int -> UpdateBandwidthRateLimitResponse
- data AddWorkingStorage = AddWorkingStorage' Text [Text]
- newAddWorkingStorage :: Text -> AddWorkingStorage
- data AddWorkingStorageResponse = AddWorkingStorageResponse' (Maybe Text) Int
- newAddWorkingStorageResponse :: Int -> AddWorkingStorageResponse
- data DescribeTapeRecoveryPoints = DescribeTapeRecoveryPoints' (Maybe Text) (Maybe Natural) Text
- newDescribeTapeRecoveryPoints :: Text -> DescribeTapeRecoveryPoints
- data DescribeTapeRecoveryPointsResponse = DescribeTapeRecoveryPointsResponse' (Maybe [TapeRecoveryPointInfo]) (Maybe Text) (Maybe Text) Int
- newDescribeTapeRecoveryPointsResponse :: Int -> DescribeTapeRecoveryPointsResponse
- data DeleteBandwidthRateLimit = DeleteBandwidthRateLimit' Text Text
- newDeleteBandwidthRateLimit :: Text -> Text -> DeleteBandwidthRateLimit
- data DeleteBandwidthRateLimitResponse = DeleteBandwidthRateLimitResponse' (Maybe Text) Int
- newDeleteBandwidthRateLimitResponse :: Int -> DeleteBandwidthRateLimitResponse
- data ActivateGateway = ActivateGateway' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text Text Text
- newActivateGateway :: Text -> Text -> Text -> Text -> ActivateGateway
- data ActivateGatewayResponse = ActivateGatewayResponse' (Maybe Text) Int
- newActivateGatewayResponse :: Int -> ActivateGatewayResponse
- data DescribeCache = DescribeCache' Text
- newDescribeCache :: Text -> DescribeCache
- data DescribeCacheResponse = DescribeCacheResponse' (Maybe Text) (Maybe [Text]) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Integer) (Maybe Double) Int
- newDescribeCacheResponse :: Int -> DescribeCacheResponse
- data DeleteVolume = DeleteVolume' Text
- newDeleteVolume :: Text -> DeleteVolume
- data DeleteVolumeResponse = DeleteVolumeResponse' (Maybe Text) Int
- newDeleteVolumeResponse :: Int -> DeleteVolumeResponse
- newtype ActiveDirectoryStatus where
- ActiveDirectoryStatus' { }
- pattern ActiveDirectoryStatus_ACCESS_DENIED :: ActiveDirectoryStatus
- pattern ActiveDirectoryStatus_DETACHED :: ActiveDirectoryStatus
- pattern ActiveDirectoryStatus_JOINED :: ActiveDirectoryStatus
- pattern ActiveDirectoryStatus_JOINING :: ActiveDirectoryStatus
- pattern ActiveDirectoryStatus_NETWORK_ERROR :: ActiveDirectoryStatus
- pattern ActiveDirectoryStatus_TIMEOUT :: ActiveDirectoryStatus
- pattern ActiveDirectoryStatus_UNKNOWN_ERROR :: ActiveDirectoryStatus
- newtype AvailabilityMonitorTestStatus where
- newtype CaseSensitivity where
- CaseSensitivity' { }
- pattern CaseSensitivity_CaseSensitive :: CaseSensitivity
- pattern CaseSensitivity_ClientSpecified :: CaseSensitivity
- newtype FileShareType where
- FileShareType' { }
- pattern FileShareType_NFS :: FileShareType
- pattern FileShareType_SMB :: FileShareType
- newtype GatewayCapacity where
- GatewayCapacity' { }
- pattern GatewayCapacity_Large :: GatewayCapacity
- pattern GatewayCapacity_Medium :: GatewayCapacity
- pattern GatewayCapacity_Small :: GatewayCapacity
- newtype HostEnvironment where
- HostEnvironment' { }
- pattern HostEnvironment_EC2 :: HostEnvironment
- pattern HostEnvironment_HYPER_V :: HostEnvironment
- pattern HostEnvironment_KVM :: HostEnvironment
- pattern HostEnvironment_OTHER :: HostEnvironment
- pattern HostEnvironment_VMWARE :: HostEnvironment
- newtype ObjectACL where
- ObjectACL' { }
- pattern ObjectACL_Authenticated_read :: ObjectACL
- pattern ObjectACL_Aws_exec_read :: ObjectACL
- pattern ObjectACL_Bucket_owner_full_control :: ObjectACL
- pattern ObjectACL_Bucket_owner_read :: ObjectACL
- pattern ObjectACL_Private :: ObjectACL
- pattern ObjectACL_Public_read :: ObjectACL
- pattern ObjectACL_Public_read_write :: ObjectACL
- newtype PoolStatus where
- PoolStatus' { }
- pattern PoolStatus_ACTIVE :: PoolStatus
- pattern PoolStatus_DELETED :: PoolStatus
- newtype RetentionLockType where
- RetentionLockType' { }
- pattern RetentionLockType_COMPLIANCE :: RetentionLockType
- pattern RetentionLockType_GOVERNANCE :: RetentionLockType
- pattern RetentionLockType_NONE :: RetentionLockType
- newtype SMBSecurityStrategy where
- newtype TapeStorageClass where
- TapeStorageClass' { }
- pattern TapeStorageClass_DEEP_ARCHIVE :: TapeStorageClass
- pattern TapeStorageClass_GLACIER :: TapeStorageClass
- data AutomaticTapeCreationPolicyInfo = AutomaticTapeCreationPolicyInfo' (Maybe Text) (Maybe (NonEmpty AutomaticTapeCreationRule))
- newAutomaticTapeCreationPolicyInfo :: AutomaticTapeCreationPolicyInfo
- data AutomaticTapeCreationRule = AutomaticTapeCreationRule' (Maybe Bool) Text Text Integer Natural
- newAutomaticTapeCreationRule :: Text -> Text -> Integer -> Natural -> AutomaticTapeCreationRule
- data BandwidthRateLimitInterval = BandwidthRateLimitInterval' (Maybe Natural) (Maybe Natural) Natural Natural Natural Natural (NonEmpty Natural)
- newBandwidthRateLimitInterval :: Natural -> Natural -> Natural -> Natural -> NonEmpty Natural -> BandwidthRateLimitInterval
- data CacheAttributes = CacheAttributes' (Maybe Int)
- newCacheAttributes :: CacheAttributes
- data CachediSCSIVolume = CachediSCSIVolume' (Maybe VolumeiSCSIAttributes) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Integer) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newCachediSCSIVolume :: CachediSCSIVolume
- data ChapInfo = ChapInfo' (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text))
- newChapInfo :: ChapInfo
- data DeviceiSCSIAttributes = DeviceiSCSIAttributes' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int)
- newDeviceiSCSIAttributes :: DeviceiSCSIAttributes
- data Disk = Disk' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe [Text])
- newDisk :: Disk
- data EndpointNetworkConfiguration = EndpointNetworkConfiguration' (Maybe [Text])
- newEndpointNetworkConfiguration :: EndpointNetworkConfiguration
- data FileShareInfo = FileShareInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe FileShareType)
- newFileShareInfo :: FileShareInfo
- data FileSystemAssociationInfo = FileSystemAssociationInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CacheAttributes) (Maybe EndpointNetworkConfiguration) (Maybe Text) (Maybe Text) (Maybe [Tag])
- newFileSystemAssociationInfo :: FileSystemAssociationInfo
- data FileSystemAssociationSummary = FileSystemAssociationSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newFileSystemAssociationSummary :: FileSystemAssociationSummary
- data GatewayInfo = GatewayInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newGatewayInfo :: GatewayInfo
- data NFSFileShareDefaults = NFSFileShareDefaults' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Natural)
- newNFSFileShareDefaults :: NFSFileShareDefaults
- data NFSFileShareInfo = NFSFileShareInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NFSFileShareDefaults) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Tag])
- newNFSFileShareInfo :: NFSFileShareInfo
- data NetworkInterface = NetworkInterface' (Maybe Text) (Maybe Text) (Maybe Text)
- newNetworkInterface :: NetworkInterface
- data PoolInfo = PoolInfo' (Maybe RetentionLockType) (Maybe Natural) (Maybe Text) (Maybe TapeStorageClass) (Maybe PoolStatus) (Maybe Text)
- newPoolInfo :: PoolInfo
- data SMBFileShareInfo = SMBFileShareInfo' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe CaseSensitivity) (Maybe [Tag])
- newSMBFileShareInfo :: SMBFileShareInfo
- data StorediSCSIVolume = StorediSCSIVolume' (Maybe VolumeiSCSIAttributes) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Integer) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newStorediSCSIVolume :: StorediSCSIVolume
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data Tape = Tape' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe POSIX) (Maybe Bool) (Maybe POSIX)
- newTape :: Tape
- data TapeArchive = TapeArchive' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe POSIX) (Maybe Bool) (Maybe POSIX) (Maybe Text)
- newTapeArchive :: TapeArchive
- data TapeInfo = TapeInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newTapeInfo :: TapeInfo
- data TapeRecoveryPointInfo = TapeRecoveryPointInfo' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Integer)
- newTapeRecoveryPointInfo :: TapeRecoveryPointInfo
- data VTLDevice = VTLDevice' (Maybe DeviceiSCSIAttributes) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newVTLDevice :: VTLDevice
- data VolumeInfo = VolumeInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text)
- newVolumeInfo :: VolumeInfo
- data VolumeRecoveryPointInfo = VolumeRecoveryPointInfo' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer)
- newVolumeRecoveryPointInfo :: VolumeRecoveryPointInfo
- data VolumeiSCSIAttributes = VolumeiSCSIAttributes' (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int)
- newVolumeiSCSIAttributes :: VolumeiSCSIAttributes
Service Configuration
defaultService :: Service Source #
API version 2013-06-30 of the Amazon Storage Gateway SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by StorageGateway.
InvalidGatewayRequestException
_InvalidGatewayRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
ServiceUnavailableError
_ServiceUnavailableError :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.
InternalServerError
_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal server error has occurred during the request. For more information, see the error and message fields.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CancelArchival
data CancelArchival Source #
CancelArchivalInput
See: newCancelArchival smart constructor.
Constructors
| CancelArchival' Text Text |
Instances
Create a value of CancelArchival with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:CancelArchival', cancelArchival_gatewayARN - Undocumented member.
$sel:tapeARN:CancelArchival', cancelArchival_tapeARN - The Amazon Resource Name (ARN) of the virtual tape you want to cancel
archiving for.
data CancelArchivalResponse Source #
CancelArchivalOutput
See: newCancelArchivalResponse smart constructor.
Constructors
| CancelArchivalResponse' (Maybe Text) Int |
Instances
newCancelArchivalResponse Source #
Create a value of CancelArchivalResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeARN:CancelArchival', cancelArchivalResponse_tapeARN - The Amazon Resource Name (ARN) of the virtual tape for which archiving
was canceled.
$sel:httpStatus:CancelArchivalResponse', cancelArchivalResponse_httpStatus - The response's http status code.
CreateStorediSCSIVolume
data CreateStorediSCSIVolume Source #
A JSON object containing one or more of the following fields:
- CreateStorediSCSIVolumeInput$DiskId
- CreateStorediSCSIVolumeInput$NetworkInterfaceId
- CreateStorediSCSIVolumeInput$PreserveExistingData
- CreateStorediSCSIVolumeInput$SnapshotId
- CreateStorediSCSIVolumeInput$TargetName
See: newCreateStorediSCSIVolume smart constructor.
Constructors
| CreateStorediSCSIVolume' (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe Text) Text Text Bool Text Text |
Instances
newCreateStorediSCSIVolume Source #
Create a value of CreateStorediSCSIVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:CreateStorediSCSIVolume', createStorediSCSIVolume_kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
used for Amazon S3 server-side encryption. Storage Gateway does not
support asymmetric CMKs. This value can only be set when KMSEncrypted
is true. Optional.
$sel:kmsEncrypted:CreateStorediSCSIVolume', createStorediSCSIVolume_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
$sel:tags:CreateStorediSCSIVolume', createStorediSCSIVolume_tags - A list of up to 50 tags that can be assigned to a stored volume. Each
tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
$sel:snapshotId:CreateStorediSCSIVolume', createStorediSCSIVolume_snapshotId - The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as
the new stored volume. Specify this field if you want to create the
iSCSI storage volume from a snapshot; otherwise, do not include this
field. To list snapshots for your account use
DescribeSnapshots
in the Amazon Elastic Compute Cloud API Reference.
$sel:gatewayARN:CreateStorediSCSIVolume', createStorediSCSIVolume_gatewayARN - Undocumented member.
$sel:diskId:CreateStorediSCSIVolume', createStorediSCSIVolume_diskId - The unique identifier for the gateway local disk that is configured as a
stored volume. Use
ListLocalDisks
to list disk IDs for a gateway.
$sel:preserveExistingData:CreateStorediSCSIVolume', createStorediSCSIVolume_preserveExistingData - Set to true if you want to preserve the data on the local disk.
Otherwise, set to false to create an empty volume.
Valid Values: true | false
$sel:targetName:CreateStorediSCSIVolume', createStorediSCSIVolume_targetName - The name of the iSCSI target used by an initiator to connect to a volume
and used as a suffix for the target ARN. For example, specifying
TargetName as myvolume results in the target ARN of
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.
The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
$sel:networkInterfaceId:CreateStorediSCSIVolume', createStorediSCSIVolume_networkInterfaceId - The network interface of the gateway on which to expose the iSCSI
target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation
to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
data CreateStorediSCSIVolumeResponse Source #
A JSON object containing the following fields:
See: newCreateStorediSCSIVolumeResponse smart constructor.
Instances
newCreateStorediSCSIVolumeResponse Source #
Create a value of CreateStorediSCSIVolumeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetARN:CreateStorediSCSIVolumeResponse', createStorediSCSIVolumeResponse_targetARN - The Amazon Resource Name (ARN) of the volume target, which includes the
iSCSI name that initiators can use to connect to the target.
$sel:volumeARN:CreateStorediSCSIVolumeResponse', createStorediSCSIVolumeResponse_volumeARN - The Amazon Resource Name (ARN) of the configured volume.
$sel:volumeSizeInBytes:CreateStorediSCSIVolumeResponse', createStorediSCSIVolumeResponse_volumeSizeInBytes - The size of the volume in bytes.
$sel:httpStatus:CreateStorediSCSIVolumeResponse', createStorediSCSIVolumeResponse_httpStatus - The response's http status code.
DescribeFileSystemAssociations
data DescribeFileSystemAssociations Source #
See: newDescribeFileSystemAssociations smart constructor.
Constructors
| DescribeFileSystemAssociations' (NonEmpty Text) |
Instances
newDescribeFileSystemAssociations Source #
Arguments
| :: NonEmpty Text |
|
| -> DescribeFileSystemAssociations |
Create a value of DescribeFileSystemAssociations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystemAssociationARNList:DescribeFileSystemAssociations', describeFileSystemAssociations_fileSystemAssociationARNList - An array containing the Amazon Resource Name (ARN) of each file system
association to be described.
data DescribeFileSystemAssociationsResponse Source #
See: newDescribeFileSystemAssociationsResponse smart constructor.
Constructors
| DescribeFileSystemAssociationsResponse' (Maybe [FileSystemAssociationInfo]) Int |
Instances
newDescribeFileSystemAssociationsResponse Source #
Arguments
| :: Int | |
| -> DescribeFileSystemAssociationsResponse |
Create a value of DescribeFileSystemAssociationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystemAssociationInfoList:DescribeFileSystemAssociationsResponse', describeFileSystemAssociationsResponse_fileSystemAssociationInfoList - An array containing the FileSystemAssociationInfo data type of each
file system association to be described.
$sel:httpStatus:DescribeFileSystemAssociationsResponse', describeFileSystemAssociationsResponse_httpStatus - The response's http status code.
CreateNFSFileShare
data CreateNFSFileShare Source #
CreateNFSFileShareInput
See: newCreateNFSFileShare smart constructor.
Constructors
| CreateNFSFileShare' (Maybe Text) (Maybe Text) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NFSFileShareDefaults) (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Tag]) Text Text Text Text |
Instances
newCreateNFSFileShare Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> CreateNFSFileShare |
Create a value of CreateNFSFileShare with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:CreateNFSFileShare', createNFSFileShare_kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
used for Amazon S3 server-side encryption. Storage Gateway does not
support asymmetric CMKs. This value can only be set when KMSEncrypted
is true. Optional.
$sel:vPCEndpointDNSName:CreateNFSFileShare', createNFSFileShare_vPCEndpointDNSName - Specifies the DNS name for the VPC endpoint that the NFS file share uses
to connect to Amazon S3.
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
$sel:cacheAttributes:CreateNFSFileShare', createNFSFileShare_cacheAttributes - Specifies refresh cache information for the file share.
$sel:objectACL:CreateNFSFileShare', createNFSFileShare_objectACL - A value that sets the access control list (ACL) permission for objects
in the S3 bucket that a S3 File Gateway puts objects into. The default
value is private.
$sel:kmsEncrypted:CreateNFSFileShare', createNFSFileShare_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
$sel:defaultStorageClass:CreateNFSFileShare', createNFSFileShare_defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by
the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING.
Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |
S3_STANDARD_IA | S3_ONEZONE_IA
$sel:fileShareName:CreateNFSFileShare', createNFSFileShare_fileShareName - The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in
LocationARN.
$sel:notificationPolicy:CreateNFSFileShare', createNFSFileShare_notificationPolicy - The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a
client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's
best to set this parameter for as long as possible to avoid generating
multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object
uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with
SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}The following example sets NotificationPolicy off.
{}$sel:squash:CreateNFSFileShare', createNFSFileShare_squash - A value that maps a user to anonymous user.
Valid values are the following:
RootSquash: Only root is mapped to anonymous user.NoSquash: No one is mapped to anonymous user.AllSquash: Everyone is mapped to anonymous user.
$sel:requesterPays:CreateNFSFileShare', createNFSFileShare_requesterPays - A value that sets who pays the cost of the request and the cost
associated with data download from the S3 bucket. If this value is set
to true, the requester pays the costs; otherwise, the S3 bucket owner
pays. However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file
share, so make sure that the configuration on the file share is the same
as the S3 bucket configuration.
Valid Values: true | false
$sel:nFSFileShareDefaults:CreateNFSFileShare', createNFSFileShare_nFSFileShareDefaults - File share default values. Optional.
$sel:clientList:CreateNFSFileShare', createNFSFileShare_clientList - The list of clients that are allowed to access the S3 File Gateway. The
list must contain either valid IP addresses or valid CIDR blocks.
$sel:guessMIMETypeEnabled:CreateNFSFileShare', createNFSFileShare_guessMIMETypeEnabled - A value that enables guessing of the MIME type for uploaded objects
based on file extensions. Set this value to true to enable MIME type
guessing, otherwise set to false. The default value is true.
Valid Values: true | false
$sel:readOnly:CreateNFSFileShare', createNFSFileShare_readOnly - A value that sets the write status of a file share. Set this value to
true to set the write status to read-only, otherwise set to false.
Valid Values: true | false
$sel:bucketRegion:CreateNFSFileShare', createNFSFileShare_bucketRegion - Specifies the Region of the S3 bucket where the NFS file share stores
files.
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
$sel:tags:CreateNFSFileShare', createNFSFileShare_tags - A list of up to 50 tags that can be assigned to the NFS file share. Each
tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
$sel:clientToken:CreateNFSFileShare', createNFSFileShare_clientToken - A unique string value that you supply that is used by S3 File Gateway to
ensure idempotent file share creation.
$sel:gatewayARN:CreateNFSFileShare', createNFSFileShare_gatewayARN - The Amazon Resource Name (ARN) of the S3 File Gateway on which you want
to create a file share.
$sel:role':CreateNFSFileShare', createNFSFileShare_role - The ARN of the Identity and Access Management (IAM) role that an S3 File
Gateway assumes when it accesses the underlying storage.
$sel:locationARN:CreateNFSFileShare', createNFSFileShare_locationARN - The ARN of the backend storage used for storing file data. A prefix name
can be added to the S3 bucket name. It must end with a "/".
You can specify a bucket attached to an access point using a complete ARN that includes the bucket region as shown:
arn:aws:s3:region:account-id:accesspoint/access-point-name
If you specify a bucket attached to an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
data CreateNFSFileShareResponse Source #
CreateNFSFileShareOutput
See: newCreateNFSFileShareResponse smart constructor.
Constructors
| CreateNFSFileShareResponse' (Maybe Text) Int |
Instances
newCreateNFSFileShareResponse Source #
Create a value of CreateNFSFileShareResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareARN:CreateNFSFileShareResponse', createNFSFileShareResponse_fileShareARN - The Amazon Resource Name (ARN) of the newly created file share.
$sel:httpStatus:CreateNFSFileShareResponse', createNFSFileShareResponse_httpStatus - The response's http status code.
AssociateFileSystem
data AssociateFileSystem Source #
See: newAssociateFileSystem smart constructor.
Constructors
| AssociateFileSystem' (Maybe Text) (Maybe CacheAttributes) (Maybe EndpointNetworkConfiguration) (Maybe [Tag]) Text (Sensitive Text) Text Text Text |
Instances
newAssociateFileSystem Source #
Create a value of AssociateFileSystem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:auditDestinationARN:AssociateFileSystem', associateFileSystem_auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for the audit logs.
$sel:cacheAttributes:AssociateFileSystem', associateFileSystem_cacheAttributes - Undocumented member.
$sel:endpointNetworkConfiguration:AssociateFileSystem', associateFileSystem_endpointNetworkConfiguration - Specifies the network configuration information for the gateway
associated with the Amazon FSx file system.
If multiple file systems are associated with this gateway, this
parameter's IpAddresses field is required.
$sel:tags:AssociateFileSystem', associateFileSystem_tags - A list of up to 50 tags that can be assigned to the file system
association. Each tag is a key-value pair.
$sel:userName:AssociateFileSystem', associateFileSystem_userName - The user name of the user credential that has permission to access the
root share D$ of the Amazon FSx file system. The user account must
belong to the Amazon FSx delegated admin user group.
$sel:password:AssociateFileSystem', associateFileSystem_password - The password of the user credential.
$sel:clientToken:AssociateFileSystem', associateFileSystem_clientToken - A unique string value that you supply that is used by the FSx File
Gateway to ensure idempotent file system association creation.
$sel:gatewayARN:AssociateFileSystem', associateFileSystem_gatewayARN - Undocumented member.
$sel:locationARN:AssociateFileSystem', associateFileSystem_locationARN - The Amazon Resource Name (ARN) of the Amazon FSx file system to
associate with the FSx File Gateway.
data AssociateFileSystemResponse Source #
See: newAssociateFileSystemResponse smart constructor.
Constructors
| AssociateFileSystemResponse' (Maybe Text) Int |
Instances
newAssociateFileSystemResponse Source #
Create a value of AssociateFileSystemResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystemAssociationARN:AssociateFileSystemResponse', associateFileSystemResponse_fileSystemAssociationARN - The ARN of the newly created file system association.
$sel:httpStatus:AssociateFileSystemResponse', associateFileSystemResponse_httpStatus - The response's http status code.
DetachVolume
data DetachVolume Source #
AttachVolumeInput
See: newDetachVolume smart constructor.
Constructors
| DetachVolume' (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> DetachVolume |
Create a value of DetachVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forceDetach:DetachVolume', detachVolume_forceDetach - Set to true to forcibly remove the iSCSI connection of the target
volume and detach the volume. The default is false. If this value is
set to false, you must manually disconnect the iSCSI connection from
the target volume.
Valid Values: true | false
$sel:volumeARN:DetachVolume', detachVolume_volumeARN - The Amazon Resource Name (ARN) of the volume to detach from the gateway.
data DetachVolumeResponse Source #
AttachVolumeOutput
See: newDetachVolumeResponse smart constructor.
Constructors
| DetachVolumeResponse' (Maybe Text) Int |
Instances
newDetachVolumeResponse Source #
Arguments
| :: Int | |
| -> DetachVolumeResponse |
Create a value of DetachVolumeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeARN:DetachVolume', detachVolumeResponse_volumeARN - The Amazon Resource Name (ARN) of the volume that was detached.
$sel:httpStatus:DetachVolumeResponse', detachVolumeResponse_httpStatus - The response's http status code.
DescribeChapCredentials
data DescribeChapCredentials Source #
A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
See: newDescribeChapCredentials smart constructor.
Constructors
| DescribeChapCredentials' Text |
Instances
newDescribeChapCredentials Source #
Create a value of DescribeChapCredentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetARN:DescribeChapCredentials', describeChapCredentials_targetARN - The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN
for specified VolumeARN.
data DescribeChapCredentialsResponse Source #
A JSON object containing the following fields:
See: newDescribeChapCredentialsResponse smart constructor.
Constructors
| DescribeChapCredentialsResponse' (Maybe [ChapInfo]) Int |
Instances
newDescribeChapCredentialsResponse Source #
Create a value of DescribeChapCredentialsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:chapCredentials:DescribeChapCredentialsResponse', describeChapCredentialsResponse_chapCredentials - An array of ChapInfo objects that represent CHAP credentials. Each
object in the array contains CHAP credential information for one
target-initiator pair. If no CHAP credentials are set, an empty array is
returned. CHAP credential information is provided in a JSON object with
the following fields:
- InitiatorName: The iSCSI initiator that connects to the target.
- SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
- SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
- TargetARN: The Amazon Resource Name (ARN) of the storage volume.
$sel:httpStatus:DescribeChapCredentialsResponse', describeChapCredentialsResponse_httpStatus - The response's http status code.
SetLocalConsolePassword
data SetLocalConsolePassword Source #
SetLocalConsolePasswordInput
See: newSetLocalConsolePassword smart constructor.
Constructors
| SetLocalConsolePassword' Text (Sensitive Text) |
Instances
newSetLocalConsolePassword Source #
Arguments
| :: Text | |
| -> Text | |
| -> SetLocalConsolePassword |
Create a value of SetLocalConsolePassword with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:SetLocalConsolePassword', setLocalConsolePassword_gatewayARN - Undocumented member.
$sel:localConsolePassword:SetLocalConsolePassword', setLocalConsolePassword_localConsolePassword - The password you want to set for your VM local console.
data SetLocalConsolePasswordResponse Source #
See: newSetLocalConsolePasswordResponse smart constructor.
Constructors
| SetLocalConsolePasswordResponse' (Maybe Text) Int |
Instances
newSetLocalConsolePasswordResponse Source #
Create a value of SetLocalConsolePasswordResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:SetLocalConsolePassword', setLocalConsolePasswordResponse_gatewayARN - Undocumented member.
$sel:httpStatus:SetLocalConsolePasswordResponse', setLocalConsolePasswordResponse_httpStatus - The response's http status code.
CreateTapes
data CreateTapes Source #
CreateTapesInput
See: newCreateTapes smart constructor.
Constructors
| CreateTapes' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe [Tag]) Text Integer Text Natural Text |
Instances
Create a value of CreateTapes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:CreateTapes', createTapes_kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
used for Amazon S3 server-side encryption. Storage Gateway does not
support asymmetric CMKs. This value can only be set when KMSEncrypted
is true. Optional.
$sel:kmsEncrypted:CreateTapes', createTapes_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
$sel:poolId:CreateTapes', createTapes_poolId - The ID of the pool that you want to add your tape to for archiving. The
tape in this pool is archived in the S3 storage class that is associated
with the pool. When you use your backup application to eject the tape,
the tape is archived directly into the storage class (S3 Glacier or S3
Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
$sel:worm:CreateTapes', createTapes_worm - Set to TRUE if the tape you are creating is to be configured as a
write-once-read-many (WORM) tape.
$sel:tags:CreateTapes', createTapes_tags - A list of up to 50 tags that can be assigned to a virtual tape. Each tag
is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
$sel:gatewayARN:CreateTapes', createTapes_gatewayARN - The unique Amazon Resource Name (ARN) that represents the gateway to
associate the virtual tapes with. Use the ListGateways operation to
return a list of gateways for your account and Region.
$sel:tapeSizeInBytes:CreateTapes', createTapes_tapeSizeInBytes - The size, in bytes, of the virtual tapes that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
$sel:clientToken:CreateTapes', createTapes_clientToken - A unique identifier that you use to retry a request. If you retry a
request, use the same ClientToken you specified in the initial
request.
Using the same ClientToken prevents creating the tape multiple times.
$sel:numTapesToCreate:CreateTapes', createTapes_numTapesToCreate - The number of virtual tapes that you want to create.
$sel:tapeBarcodePrefix:CreateTapes', createTapes_tapeBarcodePrefix - A prefix that you append to the barcode of the virtual tape you are
creating. This prefix makes the barcode unique.
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
data CreateTapesResponse Source #
CreateTapeOutput
See: newCreateTapesResponse smart constructor.
Constructors
| CreateTapesResponse' (Maybe [Text]) Int |
Instances
newCreateTapesResponse Source #
Arguments
| :: Int | |
| -> CreateTapesResponse |
Create a value of CreateTapesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeARNs:CreateTapesResponse', createTapesResponse_tapeARNs - A list of unique Amazon Resource Names (ARNs) that represents the
virtual tapes that were created.
$sel:httpStatus:CreateTapesResponse', createTapesResponse_httpStatus - The response's http status code.
UpdateVTLDeviceType
data UpdateVTLDeviceType Source #
See: newUpdateVTLDeviceType smart constructor.
Constructors
| UpdateVTLDeviceType' Text Text |
Instances
newUpdateVTLDeviceType Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateVTLDeviceType |
Create a value of UpdateVTLDeviceType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vTLDeviceARN:UpdateVTLDeviceType', updateVTLDeviceType_vTLDeviceARN - The Amazon Resource Name (ARN) of the medium changer you want to select.
$sel:deviceType:UpdateVTLDeviceType', updateVTLDeviceType_deviceType - The type of medium changer you want to select.
Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402
data UpdateVTLDeviceTypeResponse Source #
UpdateVTLDeviceTypeOutput
See: newUpdateVTLDeviceTypeResponse smart constructor.
Constructors
| UpdateVTLDeviceTypeResponse' (Maybe Text) Int |
Instances
newUpdateVTLDeviceTypeResponse Source #
Create a value of UpdateVTLDeviceTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vTLDeviceARN:UpdateVTLDeviceType', updateVTLDeviceTypeResponse_vTLDeviceARN - The Amazon Resource Name (ARN) of the medium changer you have selected.
$sel:httpStatus:UpdateVTLDeviceTypeResponse', updateVTLDeviceTypeResponse_httpStatus - The response's http status code.
CreateCachediSCSIVolume
data CreateCachediSCSIVolume Source #
See: newCreateCachediSCSIVolume smart constructor.
Constructors
| CreateCachediSCSIVolume' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Tag]) (Maybe Text) Text Integer Text Text Text |
Instances
newCreateCachediSCSIVolume Source #
Create a value of CreateCachediSCSIVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:CreateCachediSCSIVolume', createCachediSCSIVolume_kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
used for Amazon S3 server-side encryption. Storage Gateway does not
support asymmetric CMKs. This value can only be set when KMSEncrypted
is true. Optional.
$sel:sourceVolumeARN:CreateCachediSCSIVolume', createCachediSCSIVolume_sourceVolumeARN - The ARN for an existing volume. Specifying this ARN makes the new volume
into an exact copy of the specified existing volume's latest recovery
point. The VolumeSizeInBytes value for this new volume must be equal
to or larger than the size of the existing volume, in bytes.
$sel:kmsEncrypted:CreateCachediSCSIVolume', createCachediSCSIVolume_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
$sel:tags:CreateCachediSCSIVolume', createCachediSCSIVolume_tags - A list of up to 50 tags that you can assign to a cached volume. Each tag
is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
$sel:snapshotId:CreateCachediSCSIVolume', createCachediSCSIVolume_snapshotId - The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
the new cached volume. Specify this field if you want to create the
iSCSI storage volume from a snapshot; otherwise, do not include this
field. To list snapshots for your account use
DescribeSnapshots
in the Amazon Elastic Compute Cloud API Reference.
$sel:gatewayARN:CreateCachediSCSIVolume', createCachediSCSIVolume_gatewayARN - Undocumented member.
$sel:volumeSizeInBytes:CreateCachediSCSIVolume', createCachediSCSIVolume_volumeSizeInBytes - The size of the volume in bytes.
$sel:targetName:CreateCachediSCSIVolume', createCachediSCSIVolume_targetName - The name of the iSCSI target used by an initiator to connect to a volume
and used as a suffix for the target ARN. For example, specifying
TargetName as myvolume results in the target ARN of
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.
The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
$sel:networkInterfaceId:CreateCachediSCSIVolume', createCachediSCSIVolume_networkInterfaceId - The network interface of the gateway on which to expose the iSCSI
target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation
to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
$sel:clientToken:CreateCachediSCSIVolume', createCachediSCSIVolume_clientToken - A unique identifier that you use to retry a request. If you retry a
request, use the same ClientToken you specified in the initial
request.
data CreateCachediSCSIVolumeResponse Source #
See: newCreateCachediSCSIVolumeResponse smart constructor.
Instances
newCreateCachediSCSIVolumeResponse Source #
Create a value of CreateCachediSCSIVolumeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetARN:CreateCachediSCSIVolumeResponse', createCachediSCSIVolumeResponse_targetARN - The Amazon Resource Name (ARN) of the volume target, which includes the
iSCSI name that initiators can use to connect to the target.
$sel:volumeARN:CreateCachediSCSIVolumeResponse', createCachediSCSIVolumeResponse_volumeARN - The Amazon Resource Name (ARN) of the configured volume.
$sel:httpStatus:CreateCachediSCSIVolumeResponse', createCachediSCSIVolumeResponse_httpStatus - The response's http status code.
ListFileShares (Paginated)
newListFileShares :: ListFileShares Source #
Create a value of ListFileShares with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ListFileShares', listFileShares_gatewayARN - The Amazon Resource Name (ARN) of the gateway whose file shares you want
to list. If this field is not present, all file shares under your
account are listed.
$sel:marker:ListFileShares', listFileShares_marker - Opaque pagination token returned from a previous ListFileShares
operation. If present, Marker specifies where to continue the list
from after a previous call to ListFileShares. Optional.
$sel:limit:ListFileShares', listFileShares_limit - The maximum number of file shares to return in the response. The value
must be an integer with a value greater than zero. Optional.
data ListFileSharesResponse Source #
ListFileShareOutput
See: newListFileSharesResponse smart constructor.
Constructors
| ListFileSharesResponse' (Maybe [FileShareInfo]) (Maybe Text) (Maybe Text) Int |
Instances
newListFileSharesResponse Source #
Create a value of ListFileSharesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareInfoList:ListFileSharesResponse', listFileSharesResponse_fileShareInfoList - An array of information about the S3 File Gateway's file shares.
$sel:marker:ListFileShares', listFileSharesResponse_marker - If the request includes Marker, the response returns that value in
this field.
$sel:nextMarker:ListFileSharesResponse', listFileSharesResponse_nextMarker - If a value is present, there are more file shares to return. In a
subsequent request, use NextMarker as the value for Marker to
retrieve the next set of file shares.
$sel:httpStatus:ListFileSharesResponse', listFileSharesResponse_httpStatus - The response's http status code.
JoinDomain
data JoinDomain Source #
JoinDomainInput
See: newJoinDomain smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> JoinDomain |
Create a value of JoinDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:organizationalUnit:JoinDomain', joinDomain_organizationalUnit - The organizational unit (OU) is a container in an Active Directory that
can hold users, groups, computers, and other OUs and this parameter
specifies the OU that the gateway will join within the AD domain.
$sel:timeoutInSeconds:JoinDomain', joinDomain_timeoutInSeconds - Specifies the time in seconds, in which the JoinDomain operation must
complete. The default is 20 seconds.
$sel:domainControllers:JoinDomain', joinDomain_domainControllers - List of IPv4 addresses, NetBIOS names, or host names of your domain
server. If you need to specify the port number include it after the
colon (“:”). For example, mydc.mydomain.com:389.
$sel:gatewayARN:JoinDomain', joinDomain_gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and Region.
$sel:domainName:JoinDomain', joinDomain_domainName - The name of the domain that you want the gateway to join.
$sel:userName:JoinDomain', joinDomain_userName - Sets the user name of user who has permission to add the gateway to the
Active Directory domain. The domain user account should be enabled to
join computers to the domain. For example, you can use the domain
administrator account or an account with delegated permissions to join
computers to the domain.
$sel:password:JoinDomain', joinDomain_password - Sets the password of the user who has permission to add the gateway to
the Active Directory domain.
data JoinDomainResponse Source #
JoinDomainOutput
See: newJoinDomainResponse smart constructor.
Constructors
| JoinDomainResponse' (Maybe Text) (Maybe ActiveDirectoryStatus) Int |
Instances
newJoinDomainResponse Source #
Arguments
| :: Int | |
| -> JoinDomainResponse |
Create a value of JoinDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:JoinDomain', joinDomainResponse_gatewayARN - The unique Amazon Resource Name (ARN) of the gateway that joined the
domain.
$sel:activeDirectoryStatus:JoinDomainResponse', joinDomainResponse_activeDirectoryStatus - Indicates the status of the gateway as a member of the Active Directory
domain.
ACCESS_DENIED: Indicates that theJoinDomainoperation failed due to an authentication error.DETACHED: Indicates that gateway is not joined to a domain.JOINED: Indicates that the gateway has successfully joined a domain.JOINING: Indicates that aJoinDomainoperation is in progress.NETWORK_ERROR: Indicates thatJoinDomainoperation failed due to a network or connectivity error.TIMEOUT: Indicates that theJoinDomainoperation failed because the operation didn't complete within the allotted time.UNKNOWN_ERROR: Indicates that theJoinDomainoperation failed due to another type of error.
$sel:httpStatus:JoinDomainResponse', joinDomainResponse_httpStatus - The response's http status code.
DeleteFileShare
data DeleteFileShare Source #
DeleteFileShareInput
See: newDeleteFileShare smart constructor.
Constructors
| DeleteFileShare' (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> DeleteFileShare |
Create a value of DeleteFileShare with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forceDelete:DeleteFileShare', deleteFileShare_forceDelete - If this value is set to true, the operation deletes a file share
immediately and aborts all data uploads to Amazon Web Services.
Otherwise, the file share is not deleted until all data is uploaded to
Amazon Web Services. This process aborts the data upload process, and
the file share enters the FORCE_DELETING status.
Valid Values: true | false
$sel:fileShareARN:DeleteFileShare', deleteFileShare_fileShareARN - The Amazon Resource Name (ARN) of the file share to be deleted.
data DeleteFileShareResponse Source #
DeleteFileShareOutput
See: newDeleteFileShareResponse smart constructor.
Constructors
| DeleteFileShareResponse' (Maybe Text) Int |
Instances
newDeleteFileShareResponse Source #
Create a value of DeleteFileShareResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareARN:DeleteFileShare', deleteFileShareResponse_fileShareARN - The Amazon Resource Name (ARN) of the deleted file share.
$sel:httpStatus:DeleteFileShareResponse', deleteFileShareResponse_httpStatus - The response's http status code.
ListVolumeInitiators
data ListVolumeInitiators Source #
ListVolumeInitiatorsInput
See: newListVolumeInitiators smart constructor.
Constructors
| ListVolumeInitiators' Text |
Instances
newListVolumeInitiators Source #
Arguments
| :: Text | |
| -> ListVolumeInitiators |
Create a value of ListVolumeInitiators with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeARN:ListVolumeInitiators', listVolumeInitiators_volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
operation to return a list of gateway volumes for the gateway.
data ListVolumeInitiatorsResponse Source #
ListVolumeInitiatorsOutput
See: newListVolumeInitiatorsResponse smart constructor.
Constructors
| ListVolumeInitiatorsResponse' (Maybe [Text]) Int |
Instances
newListVolumeInitiatorsResponse Source #
Create a value of ListVolumeInitiatorsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:initiators:ListVolumeInitiatorsResponse', listVolumeInitiatorsResponse_initiators - The host names and port numbers of all iSCSI initiators that are
connected to the gateway.
$sel:httpStatus:ListVolumeInitiatorsResponse', listVolumeInitiatorsResponse_httpStatus - The response's http status code.
AddUploadBuffer
data AddUploadBuffer Source #
See: newAddUploadBuffer smart constructor.
Constructors
| AddUploadBuffer' Text [Text] |
Instances
Arguments
| :: Text | |
| -> AddUploadBuffer |
Create a value of AddUploadBuffer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:AddUploadBuffer', addUploadBuffer_gatewayARN - Undocumented member.
$sel:diskIds:AddUploadBuffer', addUploadBuffer_diskIds - An array of strings that identify disks that are to be configured as
working storage. Each string has a minimum length of 1 and maximum
length of 300. You can get the disk IDs from the ListLocalDisks API.
data AddUploadBufferResponse Source #
See: newAddUploadBufferResponse smart constructor.
Constructors
| AddUploadBufferResponse' (Maybe Text) Int |
Instances
newAddUploadBufferResponse Source #
Create a value of AddUploadBufferResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:AddUploadBuffer', addUploadBufferResponse_gatewayARN - Undocumented member.
$sel:httpStatus:AddUploadBufferResponse', addUploadBufferResponse_httpStatus - The response's http status code.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
ListTagsForResourceInput
See: newListTagsForResource smart constructor.
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListTagsForResource', listTagsForResource_marker - An opaque string that indicates the position at which to begin returning
the list of tags.
$sel:limit:ListTagsForResource', listTagsForResource_limit - Specifies that the list of tags returned be limited to the specified
number of items.
$sel:resourceARN:ListTagsForResource', listTagsForResource_resourceARN - The Amazon Resource Name (ARN) of the resource for which you want to
list tags.
data ListTagsForResourceResponse Source #
ListTagsForResourceOutput
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:ListTagsForResource', listTagsForResourceResponse_resourceARN - The Amazon Resource Name (ARN) of the resource for which you want to
list tags.
$sel:marker:ListTagsForResource', listTagsForResourceResponse_marker - An opaque string that indicates the position at which to stop returning
the list of tags.
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - An array that contains the tags for the specified resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
NotifyWhenUploaded
data NotifyWhenUploaded Source #
See: newNotifyWhenUploaded smart constructor.
Constructors
| NotifyWhenUploaded' Text |
Instances
newNotifyWhenUploaded Source #
Arguments
| :: Text | |
| -> NotifyWhenUploaded |
Create a value of NotifyWhenUploaded with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareARN:NotifyWhenUploaded', notifyWhenUploaded_fileShareARN - Undocumented member.
data NotifyWhenUploadedResponse Source #
See: newNotifyWhenUploadedResponse smart constructor.
Instances
newNotifyWhenUploadedResponse Source #
Create a value of NotifyWhenUploadedResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareARN:NotifyWhenUploaded', notifyWhenUploadedResponse_fileShareARN - Undocumented member.
$sel:notificationId:NotifyWhenUploadedResponse', notifyWhenUploadedResponse_notificationId - Undocumented member.
$sel:httpStatus:NotifyWhenUploadedResponse', notifyWhenUploadedResponse_httpStatus - The response's http status code.
ListTapePools (Paginated)
data ListTapePools Source #
See: newListTapePools smart constructor.
Instances
newListTapePools :: ListTapePools Source #
Create a value of ListTapePools with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:poolARNs:ListTapePools', listTapePools_poolARNs - The Amazon Resource Name (ARN) of each of the custom tape pools you want
to list. If you don't specify a custom tape pool ARN, the response
lists all custom tape pools.
$sel:marker:ListTapePools', listTapePools_marker - A string that indicates the position at which to begin the returned list
of tape pools.
$sel:limit:ListTapePools', listTapePools_limit - An optional number limit for the tape pools in the list returned by this
call.
data ListTapePoolsResponse Source #
See: newListTapePoolsResponse smart constructor.
Instances
newListTapePoolsResponse Source #
Create a value of ListTapePoolsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:poolInfos:ListTapePoolsResponse', listTapePoolsResponse_poolInfos - An array of PoolInfo objects, where each object describes a single
custom tape pool. If there are no custom tape pools, the PoolInfos is
an empty array.
$sel:marker:ListTapePools', listTapePoolsResponse_marker - A string that indicates the position at which to begin the returned list
of tape pools. Use the marker in your next request to continue
pagination of tape pools. If there are no more tape pools to list, this
element does not appear in the response body.
$sel:httpStatus:ListTapePoolsResponse', listTapePoolsResponse_httpStatus - The response's http status code.
DeleteTapePool
data DeleteTapePool Source #
See: newDeleteTapePool smart constructor.
Constructors
| DeleteTapePool' Text |
Instances
Arguments
| :: Text | |
| -> DeleteTapePool |
Create a value of DeleteTapePool with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:poolARN:DeleteTapePool', deleteTapePool_poolARN - The Amazon Resource Name (ARN) of the custom tape pool to delete.
data DeleteTapePoolResponse Source #
See: newDeleteTapePoolResponse smart constructor.
Constructors
| DeleteTapePoolResponse' (Maybe Text) Int |
Instances
newDeleteTapePoolResponse Source #
Create a value of DeleteTapePoolResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:poolARN:DeleteTapePool', deleteTapePoolResponse_poolARN - The Amazon Resource Name (ARN) of the custom tape pool being deleted.
$sel:httpStatus:DeleteTapePoolResponse', deleteTapePoolResponse_httpStatus - The response's http status code.
UpdateGatewayInformation
data UpdateGatewayInformation Source #
See: newUpdateGatewayInformation smart constructor.
Constructors
| UpdateGatewayInformation' (Maybe GatewayCapacity) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
newUpdateGatewayInformation Source #
Create a value of UpdateGatewayInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayCapacity:UpdateGatewayInformation', updateGatewayInformation_gatewayCapacity - Specifies the size of the gateway's metadata cache.
$sel:gatewayName:UpdateGatewayInformation', updateGatewayInformation_gatewayName - Undocumented member.
$sel:gatewayTimezone:UpdateGatewayInformation', updateGatewayInformation_gatewayTimezone - A value that indicates the time zone of the gateway.
$sel:cloudWatchLogGroupARN:UpdateGatewayInformation', updateGatewayInformation_cloudWatchLogGroupARN - The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
you want to use to monitor and log events in the gateway.
For more information, see What is Amazon CloudWatch Logs?
$sel:gatewayARN:UpdateGatewayInformation', updateGatewayInformation_gatewayARN - Undocumented member.
data UpdateGatewayInformationResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
See: newUpdateGatewayInformationResponse smart constructor.
Instances
newUpdateGatewayInformationResponse Source #
Create a value of UpdateGatewayInformationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateGatewayInformation', updateGatewayInformationResponse_gatewayARN - Undocumented member.
$sel:gatewayName:UpdateGatewayInformation', updateGatewayInformationResponse_gatewayName - The name you configured for your gateway.
$sel:httpStatus:UpdateGatewayInformationResponse', updateGatewayInformationResponse_httpStatus - The response's http status code.
DescribeMaintenanceStartTime
data DescribeMaintenanceStartTime Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
See: newDescribeMaintenanceStartTime smart constructor.
Constructors
| DescribeMaintenanceStartTime' Text |
Instances
newDescribeMaintenanceStartTime Source #
Create a value of DescribeMaintenanceStartTime with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeMaintenanceStartTime', describeMaintenanceStartTime_gatewayARN - Undocumented member.
data DescribeMaintenanceStartTimeResponse Source #
A JSON object containing the following fields:
- DescribeMaintenanceStartTimeOutput$DayOfMonth
- DescribeMaintenanceStartTimeOutput$DayOfWeek
- DescribeMaintenanceStartTimeOutput$HourOfDay
- DescribeMaintenanceStartTimeOutput$MinuteOfHour
- DescribeMaintenanceStartTimeOutput$Timezone
See: newDescribeMaintenanceStartTimeResponse smart constructor.
Constructors
| DescribeMaintenanceStartTimeResponse' (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Natural) Int |
Instances
newDescribeMaintenanceStartTimeResponse Source #
Arguments
| :: Int | |
| -> DescribeMaintenanceStartTimeResponse |
Create a value of DescribeMaintenanceStartTimeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeMaintenanceStartTime', describeMaintenanceStartTimeResponse_gatewayARN - Undocumented member.
$sel:minuteOfHour:DescribeMaintenanceStartTimeResponse', describeMaintenanceStartTimeResponse_minuteOfHour - The minute component of the maintenance start time represented as mm,
where mm is the minute (0 to 59). The minute of the hour is in the
time zone of the gateway.
$sel:dayOfMonth:DescribeMaintenanceStartTimeResponse', describeMaintenanceStartTimeResponse_dayOfMonth - The day of the month component of the maintenance start time represented
as an ordinal number from 1 to 28, where 1 represents the first day of
the month and 28 represents the last day of the month.
$sel:hourOfDay:DescribeMaintenanceStartTimeResponse', describeMaintenanceStartTimeResponse_hourOfDay - The hour component of the maintenance start time represented as hh,
where hh is the hour (0 to 23). The hour of the day is in the time
zone of the gateway.
$sel:timezone:DescribeMaintenanceStartTimeResponse', describeMaintenanceStartTimeResponse_timezone - A value that indicates the time zone that is set for the gateway. The
start time and day of week specified should be in the time zone of the
gateway.
$sel:dayOfWeek:DescribeMaintenanceStartTimeResponse', describeMaintenanceStartTimeResponse_dayOfWeek - An ordinal number between 0 and 6 that represents the day of the week,
where 0 represents Sunday and 6 represents Saturday. The day of week is
in the time zone of the gateway.
$sel:httpStatus:DescribeMaintenanceStartTimeResponse', describeMaintenanceStartTimeResponse_httpStatus - The response's http status code.
AssignTapePool
data AssignTapePool Source #
See: newAssignTapePool smart constructor.
Constructors
| AssignTapePool' (Maybe Bool) Text Text |
Instances
Create a value of AssignTapePool with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bypassGovernanceRetention:AssignTapePool', assignTapePool_bypassGovernanceRetention - Set permissions to bypass governance retention. If the lock type of the
archived tape is Governance, the tape's archived age is not older
than RetentionLockInDays, and the user does not already have
BypassGovernanceRetention, setting this to TRUE enables the user to
bypass the retention lock. This parameter is set to true by default for
calls from the console.
Valid values: TRUE | FALSE
$sel:tapeARN:AssignTapePool', assignTapePool_tapeARN - The unique Amazon Resource Name (ARN) of the virtual tape that you want
to add to the tape pool.
$sel:poolId:AssignTapePool', assignTapePool_poolId - The ID of the pool that you want to add your tape to for archiving. The
tape in this pool is archived in the S3 storage class that is associated
with the pool. When you use your backup application to eject the tape,
the tape is archived directly into the storage class (S3 Glacier or S3
Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
data AssignTapePoolResponse Source #
See: newAssignTapePoolResponse smart constructor.
Constructors
| AssignTapePoolResponse' (Maybe Text) Int |
Instances
newAssignTapePoolResponse Source #
Create a value of AssignTapePoolResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeARN:AssignTapePool', assignTapePoolResponse_tapeARN - The unique Amazon Resource Names (ARN) of the virtual tape that was
added to the tape pool.
$sel:httpStatus:AssignTapePoolResponse', assignTapePoolResponse_httpStatus - The response's http status code.
DescribeWorkingStorage
data DescribeWorkingStorage Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
See: newDescribeWorkingStorage smart constructor.
Constructors
| DescribeWorkingStorage' Text |
Instances
newDescribeWorkingStorage Source #
Create a value of DescribeWorkingStorage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeWorkingStorage', describeWorkingStorage_gatewayARN - Undocumented member.
data DescribeWorkingStorageResponse Source #
A JSON object containing the following fields:
See: newDescribeWorkingStorageResponse smart constructor.
Constructors
| DescribeWorkingStorageResponse' (Maybe Text) (Maybe [Text]) (Maybe Integer) (Maybe Integer) Int |
Instances
newDescribeWorkingStorageResponse Source #
Create a value of DescribeWorkingStorageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeWorkingStorage', describeWorkingStorageResponse_gatewayARN - Undocumented member.
$sel:diskIds:DescribeWorkingStorageResponse', describeWorkingStorageResponse_diskIds - An array of the gateway's local disk IDs that are configured as working
storage. Each local disk ID is specified as a string (minimum length of
1 and maximum length of 300). If no local disks are configured as
working storage, then the DiskIds array is empty.
$sel:workingStorageAllocatedInBytes:DescribeWorkingStorageResponse', describeWorkingStorageResponse_workingStorageAllocatedInBytes - The total working storage in bytes allocated for the gateway. If no
working storage is configured for the gateway, this field returns 0.
$sel:workingStorageUsedInBytes:DescribeWorkingStorageResponse', describeWorkingStorageResponse_workingStorageUsedInBytes - The total working storage in bytes in use by the gateway. If no working
storage is configured for the gateway, this field returns 0.
$sel:httpStatus:DescribeWorkingStorageResponse', describeWorkingStorageResponse_httpStatus - The response's http status code.
DescribeCachediSCSIVolumes
data DescribeCachediSCSIVolumes Source #
See: newDescribeCachediSCSIVolumes smart constructor.
Constructors
| DescribeCachediSCSIVolumes' [Text] |
Instances
newDescribeCachediSCSIVolumes :: DescribeCachediSCSIVolumes Source #
Create a value of DescribeCachediSCSIVolumes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeARNs:DescribeCachediSCSIVolumes', describeCachediSCSIVolumes_volumeARNs - An array of strings where each string represents the Amazon Resource
Name (ARN) of a cached volume. All of the specified cached volumes must
be from the same gateway. Use ListVolumes to get volume ARNs for a
gateway.
data DescribeCachediSCSIVolumesResponse Source #
A JSON object containing the following fields:
See: newDescribeCachediSCSIVolumesResponse smart constructor.
Constructors
| DescribeCachediSCSIVolumesResponse' (Maybe [CachediSCSIVolume]) Int |
Instances
newDescribeCachediSCSIVolumesResponse Source #
Arguments
| :: Int | |
| -> DescribeCachediSCSIVolumesResponse |
Create a value of DescribeCachediSCSIVolumesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cachediSCSIVolumes:DescribeCachediSCSIVolumesResponse', describeCachediSCSIVolumesResponse_cachediSCSIVolumes - An array of objects where each object contains metadata about one cached
volume.
$sel:httpStatus:DescribeCachediSCSIVolumesResponse', describeCachediSCSIVolumesResponse_httpStatus - The response's http status code.
AddCache
See: newAddCache smart constructor.
Instances
Create a value of AddCache with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:AddCache', addCache_gatewayARN - Undocumented member.
$sel:diskIds:AddCache', addCache_diskIds - An array of strings that identify disks that are to be configured as
working storage. Each string has a minimum length of 1 and maximum
length of 300. You can get the disk IDs from the ListLocalDisks API.
data AddCacheResponse Source #
See: newAddCacheResponse smart constructor.
Constructors
| AddCacheResponse' (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> AddCacheResponse |
Create a value of AddCacheResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:AddCache', addCacheResponse_gatewayARN - Undocumented member.
$sel:httpStatus:AddCacheResponse', addCacheResponse_httpStatus - The response's http status code.
CreateTapePool
data CreateTapePool Source #
See: newCreateTapePool smart constructor.
Constructors
| CreateTapePool' (Maybe RetentionLockType) (Maybe Natural) (Maybe [Tag]) Text TapeStorageClass |
Instances
Arguments
| :: Text | |
| -> TapeStorageClass | |
| -> CreateTapePool |
Create a value of CreateTapePool with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:retentionLockType:CreateTapePool', createTapePool_retentionLockType - Tape retention lock can be configured in two modes. When configured in
governance mode, accounts with specific IAM permissions are authorized
to remove the tape retention lock from archived virtual tapes. When
configured in compliance mode, the tape retention lock cannot be removed
by any user, including the root account.
$sel:retentionLockTimeInDays:CreateTapePool', createTapePool_retentionLockTimeInDays - Tape retention lock time is set in days. Tape retention lock can be
enabled for up to 100 years (36,500 days).
$sel:tags:CreateTapePool', createTapePool_tags - A list of up to 50 tags that can be assigned to tape pool. Each tag is a
key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
$sel:poolName:CreateTapePool', createTapePool_poolName - The name of the new custom tape pool.
$sel:storageClass:CreateTapePool', createTapePool_storageClass - The storage class that is associated with the new custom pool. When you
use your backup application to eject the tape, the tape is archived
directly into the storage class (S3 Glacier or S3 Glacier Deep Archive)
that corresponds to the pool.
data CreateTapePoolResponse Source #
See: newCreateTapePoolResponse smart constructor.
Constructors
| CreateTapePoolResponse' (Maybe Text) Int |
Instances
newCreateTapePoolResponse Source #
Create a value of CreateTapePoolResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:poolARN:CreateTapePoolResponse', createTapePoolResponse_poolARN - The unique Amazon Resource Name (ARN) that represents the custom tape
pool. Use the ListTapePools operation to return a list of tape pools for
your account and Region.
$sel:httpStatus:CreateTapePoolResponse', createTapePoolResponse_httpStatus - The response's http status code.
StartGateway
data StartGateway Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.
See: newStartGateway smart constructor.
Constructors
| StartGateway' Text |
Instances
Arguments
| :: Text | |
| -> StartGateway |
Create a value of StartGateway with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:StartGateway', startGateway_gatewayARN - Undocumented member.
data StartGatewayResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was restarted.
See: newStartGatewayResponse smart constructor.
Constructors
| StartGatewayResponse' (Maybe Text) Int |
Instances
newStartGatewayResponse Source #
Arguments
| :: Int | |
| -> StartGatewayResponse |
Create a value of StartGatewayResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:StartGateway', startGatewayResponse_gatewayARN - Undocumented member.
$sel:httpStatus:StartGatewayResponse', startGatewayResponse_httpStatus - The response's http status code.
ShutdownGateway
data ShutdownGateway Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.
See: newShutdownGateway smart constructor.
Constructors
| ShutdownGateway' Text |
Instances
Arguments
| :: Text | |
| -> ShutdownGateway |
Create a value of ShutdownGateway with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ShutdownGateway', shutdownGateway_gatewayARN - Undocumented member.
data ShutdownGatewayResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut down.
See: newShutdownGatewayResponse smart constructor.
Constructors
| ShutdownGatewayResponse' (Maybe Text) Int |
Instances
newShutdownGatewayResponse Source #
Create a value of ShutdownGatewayResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ShutdownGateway', shutdownGatewayResponse_gatewayARN - Undocumented member.
$sel:httpStatus:ShutdownGatewayResponse', shutdownGatewayResponse_httpStatus - The response's http status code.
ListAutomaticTapeCreationPolicies
data ListAutomaticTapeCreationPolicies Source #
See: newListAutomaticTapeCreationPolicies smart constructor.
Constructors
| ListAutomaticTapeCreationPolicies' (Maybe Text) |
Instances
newListAutomaticTapeCreationPolicies :: ListAutomaticTapeCreationPolicies Source #
Create a value of ListAutomaticTapeCreationPolicies with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ListAutomaticTapeCreationPolicies', listAutomaticTapeCreationPolicies_gatewayARN - Undocumented member.
data ListAutomaticTapeCreationPoliciesResponse Source #
See: newListAutomaticTapeCreationPoliciesResponse smart constructor.
Constructors
| ListAutomaticTapeCreationPoliciesResponse' (Maybe [AutomaticTapeCreationPolicyInfo]) Int |
Instances
newListAutomaticTapeCreationPoliciesResponse Source #
Arguments
| :: Int | |
| -> ListAutomaticTapeCreationPoliciesResponse |
Create a value of ListAutomaticTapeCreationPoliciesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automaticTapeCreationPolicyInfos:ListAutomaticTapeCreationPoliciesResponse', listAutomaticTapeCreationPoliciesResponse_automaticTapeCreationPolicyInfos - Gets a listing of information about the gateway's automatic tape
creation policies, including the automatic tape creation rules and the
gateway that is using the policies.
$sel:httpStatus:ListAutomaticTapeCreationPoliciesResponse', listAutomaticTapeCreationPoliciesResponse_httpStatus - The response's http status code.
UpdateGatewaySoftwareNow
data UpdateGatewaySoftwareNow Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.
See: newUpdateGatewaySoftwareNow smart constructor.
Constructors
| UpdateGatewaySoftwareNow' Text |
Instances
newUpdateGatewaySoftwareNow Source #
Create a value of UpdateGatewaySoftwareNow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateGatewaySoftwareNow', updateGatewaySoftwareNow_gatewayARN - Undocumented member.
data UpdateGatewaySoftwareNowResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
See: newUpdateGatewaySoftwareNowResponse smart constructor.
Constructors
| UpdateGatewaySoftwareNowResponse' (Maybe Text) Int |
Instances
newUpdateGatewaySoftwareNowResponse Source #
Create a value of UpdateGatewaySoftwareNowResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateGatewaySoftwareNow', updateGatewaySoftwareNowResponse_gatewayARN - Undocumented member.
$sel:httpStatus:UpdateGatewaySoftwareNowResponse', updateGatewaySoftwareNowResponse_httpStatus - The response's http status code.
RemoveTagsFromResource
data RemoveTagsFromResource Source #
RemoveTagsFromResourceInput
See: newRemoveTagsFromResource smart constructor.
Constructors
| RemoveTagsFromResource' Text [Text] |
Instances
newRemoveTagsFromResource Source #
Create a value of RemoveTagsFromResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:RemoveTagsFromResource', removeTagsFromResource_resourceARN - The Amazon Resource Name (ARN) of the resource you want to remove the
tags from.
$sel:tagKeys:RemoveTagsFromResource', removeTagsFromResource_tagKeys - The keys of the tags you want to remove from the specified resource. A
tag is composed of a key-value pair.
data RemoveTagsFromResourceResponse Source #
RemoveTagsFromResourceOutput
See: newRemoveTagsFromResourceResponse smart constructor.
Constructors
| RemoveTagsFromResourceResponse' (Maybe Text) Int |
Instances
newRemoveTagsFromResourceResponse Source #
Create a value of RemoveTagsFromResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:RemoveTagsFromResource', removeTagsFromResourceResponse_resourceARN - The Amazon Resource Name (ARN) of the resource that the tags were
removed from.
$sel:httpStatus:RemoveTagsFromResourceResponse', removeTagsFromResourceResponse_httpStatus - The response's http status code.
UpdateFileSystemAssociation
data UpdateFileSystemAssociation Source #
See: newUpdateFileSystemAssociation smart constructor.
Constructors
| UpdateFileSystemAssociation' (Maybe Text) (Maybe CacheAttributes) (Maybe Text) (Maybe (Sensitive Text)) Text |
Instances
newUpdateFileSystemAssociation Source #
Arguments
| :: Text | |
| -> UpdateFileSystemAssociation |
Create a value of UpdateFileSystemAssociation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:auditDestinationARN:UpdateFileSystemAssociation', updateFileSystemAssociation_auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for the audit logs.
$sel:cacheAttributes:UpdateFileSystemAssociation', updateFileSystemAssociation_cacheAttributes - Undocumented member.
$sel:userName:UpdateFileSystemAssociation', updateFileSystemAssociation_userName - The user name of the user credential that has permission to access the
root share D$ of the Amazon FSx file system. The user account must
belong to the Amazon FSx delegated admin user group.
$sel:password:UpdateFileSystemAssociation', updateFileSystemAssociation_password - The password of the user credential.
$sel:fileSystemAssociationARN:UpdateFileSystemAssociation', updateFileSystemAssociation_fileSystemAssociationARN - The Amazon Resource Name (ARN) of the file system association that you
want to update.
data UpdateFileSystemAssociationResponse Source #
See: newUpdateFileSystemAssociationResponse smart constructor.
Constructors
| UpdateFileSystemAssociationResponse' (Maybe Text) Int |
Instances
newUpdateFileSystemAssociationResponse Source #
Arguments
| :: Int | |
| -> UpdateFileSystemAssociationResponse |
Create a value of UpdateFileSystemAssociationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystemAssociationARN:UpdateFileSystemAssociation', updateFileSystemAssociationResponse_fileSystemAssociationARN - The ARN of the updated file system association.
$sel:httpStatus:UpdateFileSystemAssociationResponse', updateFileSystemAssociationResponse_httpStatus - The response's http status code.
CreateSMBFileShare
data CreateSMBFileShare Source #
CreateSMBFileShareInput
See: newCreateSMBFileShare smart constructor.
Constructors
| CreateSMBFileShare' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe CaseSensitivity) (Maybe [Tag]) Text Text Text Text |
Instances
newCreateSMBFileShare Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> CreateSMBFileShare |
Create a value of CreateSMBFileShare with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessBasedEnumeration:CreateSMBFileShare', createSMBFileShare_accessBasedEnumeration - The files and folders on this share will only be visible to users with
read access.
$sel:adminUserList:CreateSMBFileShare', createSMBFileShare_adminUserList - A list of users or groups in the Active Directory that will be granted
administrator privileges on the file share. These users can do all file
operations as the super-user. Acceptable formats include:
DOMAIN\User1, user1, @group1, and @DOMAIN\group1.
Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
$sel:auditDestinationARN:CreateSMBFileShare', createSMBFileShare_auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for audit logs.
$sel:invalidUserList:CreateSMBFileShare', createSMBFileShare_invalidUserList - A list of users or groups in the Active Directory that are not allowed
to access the file share. A group must be prefixed with the @
character. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is
set to ActiveDirectory.
$sel:kmsKey:CreateSMBFileShare', createSMBFileShare_kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
used for Amazon S3 server-side encryption. Storage Gateway does not
support asymmetric CMKs. This value can only be set when KMSEncrypted
is true. Optional.
$sel:validUserList:CreateSMBFileShare', createSMBFileShare_validUserList - A list of users or groups in the Active Directory that are allowed to
access the file share. A group must be prefixed with the @
character. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is
set to ActiveDirectory.
$sel:vPCEndpointDNSName:CreateSMBFileShare', createSMBFileShare_vPCEndpointDNSName - Specifies the DNS name for the VPC endpoint that the SMB file share uses
to connect to Amazon S3.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
$sel:authentication:CreateSMBFileShare', createSMBFileShare_authentication - The authentication method that users use to access the file share. The
default is ActiveDirectory.
Valid Values: ActiveDirectory | GuestAccess
$sel:cacheAttributes:CreateSMBFileShare', createSMBFileShare_cacheAttributes - Specifies refresh cache information for the file share.
$sel:objectACL:CreateSMBFileShare', createSMBFileShare_objectACL - A value that sets the access control list (ACL) permission for objects
in the S3 bucket that a S3 File Gateway puts objects into. The default
value is private.
$sel:kmsEncrypted:CreateSMBFileShare', createSMBFileShare_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
$sel:defaultStorageClass:CreateSMBFileShare', createSMBFileShare_defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by
the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING.
Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |
S3_STANDARD_IA | S3_ONEZONE_IA
$sel:fileShareName:CreateSMBFileShare', createSMBFileShare_fileShareName - The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in
LocationARN.
$sel:sMBACLEnabled:CreateSMBFileShare', createSMBFileShare_sMBACLEnabled - Set this value to true to enable access control list (ACL) on the SMB
file share. Set it to false to map file and directory permissions to
the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
Valid Values: true | false
$sel:oplocksEnabled:CreateSMBFileShare', createSMBFileShare_oplocksEnabled - Specifies whether opportunistic locking is enabled for the SMB file
share.
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
$sel:notificationPolicy:CreateSMBFileShare', createSMBFileShare_notificationPolicy - The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a
client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's
best to set this parameter for as long as possible to avoid generating
multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object
uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with
SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}The following example sets NotificationPolicy off.
{}$sel:requesterPays:CreateSMBFileShare', createSMBFileShare_requesterPays - A value that sets who pays the cost of the request and the cost
associated with data download from the S3 bucket. If this value is set
to true, the requester pays the costs; otherwise, the S3 bucket owner
pays. However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file
share, so make sure that the configuration on the file share is the same
as the S3 bucket configuration.
Valid Values: true | false
$sel:guessMIMETypeEnabled:CreateSMBFileShare', createSMBFileShare_guessMIMETypeEnabled - A value that enables guessing of the MIME type for uploaded objects
based on file extensions. Set this value to true to enable MIME type
guessing, otherwise set to false. The default value is true.
Valid Values: true | false
$sel:readOnly:CreateSMBFileShare', createSMBFileShare_readOnly - A value that sets the write status of a file share. Set this value to
true to set the write status to read-only, otherwise set to false.
Valid Values: true | false
$sel:bucketRegion:CreateSMBFileShare', createSMBFileShare_bucketRegion - Specifies the Region of the S3 bucket where the SMB file share stores
files.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
$sel:caseSensitivity:CreateSMBFileShare', createSMBFileShare_caseSensitivity - The case of an object name in an Amazon S3 bucket. For
ClientSpecified, the client determines the case sensitivity. For
CaseSensitive, the gateway determines the case sensitivity. The
default value is ClientSpecified.
$sel:tags:CreateSMBFileShare', createSMBFileShare_tags - A list of up to 50 tags that can be assigned to the NFS file share. Each
tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
$sel:clientToken:CreateSMBFileShare', createSMBFileShare_clientToken - A unique string value that you supply that is used by S3 File Gateway to
ensure idempotent file share creation.
$sel:gatewayARN:CreateSMBFileShare', createSMBFileShare_gatewayARN - The ARN of the S3 File Gateway on which you want to create a file share.
$sel:role':CreateSMBFileShare', createSMBFileShare_role - The ARN of the Identity and Access Management (IAM) role that an S3 File
Gateway assumes when it accesses the underlying storage.
$sel:locationARN:CreateSMBFileShare', createSMBFileShare_locationARN - The ARN of the backend storage used for storing file data. A prefix name
can be added to the S3 bucket name. It must end with a "/".
You can specify a bucket attached to an access point using a complete ARN that includes the bucket region as shown:
arn:aws:s3:region:account-id:accesspoint/access-point-name
If you specify a bucket attached to an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
data CreateSMBFileShareResponse Source #
CreateSMBFileShareOutput
See: newCreateSMBFileShareResponse smart constructor.
Constructors
| CreateSMBFileShareResponse' (Maybe Text) Int |
Instances
newCreateSMBFileShareResponse Source #
Create a value of CreateSMBFileShareResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareARN:CreateSMBFileShareResponse', createSMBFileShareResponse_fileShareARN - The Amazon Resource Name (ARN) of the newly created file share.
$sel:httpStatus:CreateSMBFileShareResponse', createSMBFileShareResponse_httpStatus - The response's http status code.
DeleteChapCredentials
data DeleteChapCredentials Source #
A JSON object containing one or more of the following fields:
- DeleteChapCredentialsInput$InitiatorName
- DeleteChapCredentialsInput$TargetARN
See: newDeleteChapCredentials smart constructor.
Constructors
| DeleteChapCredentials' Text Text |
Instances
newDeleteChapCredentials Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteChapCredentials |
Create a value of DeleteChapCredentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetARN:DeleteChapCredentials', deleteChapCredentials_targetARN - The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN
for specified VolumeARN.
$sel:initiatorName:DeleteChapCredentials', deleteChapCredentials_initiatorName - The iSCSI initiator that connects to the target.
data DeleteChapCredentialsResponse Source #
A JSON object containing the following fields:
See: newDeleteChapCredentialsResponse smart constructor.
Instances
newDeleteChapCredentialsResponse Source #
Create a value of DeleteChapCredentialsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetARN:DeleteChapCredentials', deleteChapCredentialsResponse_targetARN - The Amazon Resource Name (ARN) of the target.
$sel:initiatorName:DeleteChapCredentials', deleteChapCredentialsResponse_initiatorName - The iSCSI initiator that connects to the target.
$sel:httpStatus:DeleteChapCredentialsResponse', deleteChapCredentialsResponse_httpStatus - The response's http status code.
UpdateChapCredentials
data UpdateChapCredentials Source #
A JSON object containing one or more of the following fields:
- UpdateChapCredentialsInput$InitiatorName
- UpdateChapCredentialsInput$SecretToAuthenticateInitiator
- UpdateChapCredentialsInput$SecretToAuthenticateTarget
- UpdateChapCredentialsInput$TargetARN
See: newUpdateChapCredentials smart constructor.
Instances
newUpdateChapCredentials Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateChapCredentials |
Create a value of UpdateChapCredentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretToAuthenticateTarget:UpdateChapCredentials', updateChapCredentials_secretToAuthenticateTarget - The secret key that the target must provide to participate in mutual
CHAP with the initiator (e.g. Windows client).
Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
$sel:targetARN:UpdateChapCredentials', updateChapCredentials_targetARN - The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
DescribeStorediSCSIVolumes operation to return the TargetARN for
specified VolumeARN.
$sel:secretToAuthenticateInitiator:UpdateChapCredentials', updateChapCredentials_secretToAuthenticateInitiator - The secret key that the initiator (for example, the Windows client) must
provide to participate in mutual CHAP with the target.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
$sel:initiatorName:UpdateChapCredentials', updateChapCredentials_initiatorName - The iSCSI initiator that connects to the target.
data UpdateChapCredentialsResponse Source #
A JSON object containing the following fields:
See: newUpdateChapCredentialsResponse smart constructor.
Instances
newUpdateChapCredentialsResponse Source #
Create a value of UpdateChapCredentialsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetARN:UpdateChapCredentials', updateChapCredentialsResponse_targetARN - The Amazon Resource Name (ARN) of the target. This is the same target
specified in the request.
$sel:initiatorName:UpdateChapCredentials', updateChapCredentialsResponse_initiatorName - The iSCSI initiator that connects to the target. This is the same
initiator name specified in the request.
$sel:httpStatus:UpdateChapCredentialsResponse', updateChapCredentialsResponse_httpStatus - The response's http status code.
AttachVolume
data AttachVolume Source #
AttachVolumeInput
See: newAttachVolume smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AttachVolume |
Create a value of AttachVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:diskId:AttachVolume', attachVolume_diskId - The unique device ID or other distinguishing data that identifies the
local disk used to create the volume. This value is only required when
you are attaching a stored volume.
$sel:targetName:AttachVolume', attachVolume_targetName - The name of the iSCSI target used by an initiator to connect to a volume
and used as a suffix for the target ARN. For example, specifying
TargetName as myvolume results in the target ARN of
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.
The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
$sel:gatewayARN:AttachVolume', attachVolume_gatewayARN - The Amazon Resource Name (ARN) of the gateway that you want to attach
the volume to.
$sel:volumeARN:AttachVolume', attachVolume_volumeARN - The Amazon Resource Name (ARN) of the volume to attach to the specified
gateway.
$sel:networkInterfaceId:AttachVolume', attachVolume_networkInterfaceId - The network interface of the gateway on which to expose the iSCSI
target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation
to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
data AttachVolumeResponse Source #
AttachVolumeOutput
See: newAttachVolumeResponse smart constructor.
Instances
newAttachVolumeResponse Source #
Arguments
| :: Int | |
| -> AttachVolumeResponse |
Create a value of AttachVolumeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetARN:AttachVolumeResponse', attachVolumeResponse_targetARN - The Amazon Resource Name (ARN) of the volume target, which includes the
iSCSI name for the initiator that was used to connect to the target.
$sel:volumeARN:AttachVolume', attachVolumeResponse_volumeARN - The Amazon Resource Name (ARN) of the volume that was attached to the
gateway.
$sel:httpStatus:AttachVolumeResponse', attachVolumeResponse_httpStatus - The response's http status code.
DescribeAvailabilityMonitorTest
data DescribeAvailabilityMonitorTest Source #
See: newDescribeAvailabilityMonitorTest smart constructor.
Constructors
| DescribeAvailabilityMonitorTest' Text |
Instances
newDescribeAvailabilityMonitorTest Source #
Create a value of DescribeAvailabilityMonitorTest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeAvailabilityMonitorTest', describeAvailabilityMonitorTest_gatewayARN - Undocumented member.
data DescribeAvailabilityMonitorTestResponse Source #
See: newDescribeAvailabilityMonitorTestResponse smart constructor.
Constructors
| DescribeAvailabilityMonitorTestResponse' (Maybe AvailabilityMonitorTestStatus) (Maybe POSIX) (Maybe Text) Int |
Instances
newDescribeAvailabilityMonitorTestResponse Source #
Arguments
| :: Int | |
| -> DescribeAvailabilityMonitorTestResponse |
Create a value of DescribeAvailabilityMonitorTestResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DescribeAvailabilityMonitorTestResponse', describeAvailabilityMonitorTestResponse_status - The status of the high availability monitoring test. If a test hasn't
been performed, the value of this field is null.
$sel:startTime:DescribeAvailabilityMonitorTestResponse', describeAvailabilityMonitorTestResponse_startTime - The time the high availability monitoring test was started. If a test
hasn't been performed, the value of this field is null.
$sel:gatewayARN:DescribeAvailabilityMonitorTest', describeAvailabilityMonitorTestResponse_gatewayARN - Undocumented member.
$sel:httpStatus:DescribeAvailabilityMonitorTestResponse', describeAvailabilityMonitorTestResponse_httpStatus - The response's http status code.
DescribeUploadBuffer
data DescribeUploadBuffer Source #
See: newDescribeUploadBuffer smart constructor.
Constructors
| DescribeUploadBuffer' Text |
Instances
newDescribeUploadBuffer Source #
Create a value of DescribeUploadBuffer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeUploadBuffer', describeUploadBuffer_gatewayARN - Undocumented member.
data DescribeUploadBufferResponse Source #
See: newDescribeUploadBufferResponse smart constructor.
Constructors
| DescribeUploadBufferResponse' (Maybe Integer) (Maybe Text) (Maybe [Text]) (Maybe Integer) Int |
Instances
newDescribeUploadBufferResponse Source #
Create a value of DescribeUploadBufferResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:uploadBufferAllocatedInBytes:DescribeUploadBufferResponse', describeUploadBufferResponse_uploadBufferAllocatedInBytes - The total number of bytes allocated in the gateway's as upload buffer.
$sel:gatewayARN:DescribeUploadBuffer', describeUploadBufferResponse_gatewayARN - Undocumented member.
$sel:diskIds:DescribeUploadBufferResponse', describeUploadBufferResponse_diskIds - An array of the gateway's local disk IDs that are configured as working
storage. Each local disk ID is specified as a string (minimum length of
1 and maximum length of 300). If no local disks are configured as
working storage, then the DiskIds array is empty.
$sel:uploadBufferUsedInBytes:DescribeUploadBufferResponse', describeUploadBufferResponse_uploadBufferUsedInBytes - The total number of bytes being used in the gateway's upload buffer.
$sel:httpStatus:DescribeUploadBufferResponse', describeUploadBufferResponse_httpStatus - The response's http status code.
DescribeTapes (Paginated)
data DescribeTapes Source #
DescribeTapesInput
See: newDescribeTapes smart constructor.
Instances
Arguments
| :: Text | |
| -> DescribeTapes |
Create a value of DescribeTapes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeTapes', describeTapes_marker - A marker value, obtained in a previous call to DescribeTapes. This
marker indicates which page of results to retrieve.
If not specified, the first page of results is retrieved.
$sel:limit:DescribeTapes', describeTapes_limit - Specifies that the number of virtual tapes described be limited to the
specified number.
Amazon Web Services may impose its own limit, if this field is not set.
$sel:tapeARNs:DescribeTapes', describeTapes_tapeARNs - Specifies one or more unique Amazon Resource Names (ARNs) that represent
the virtual tapes you want to describe. If this parameter is not
specified, Tape gateway returns a description of all virtual tapes
associated with the specified gateway.
$sel:gatewayARN:DescribeTapes', describeTapes_gatewayARN - Undocumented member.
data DescribeTapesResponse Source #
DescribeTapesOutput
See: newDescribeTapesResponse smart constructor.
Instances
newDescribeTapesResponse Source #
Create a value of DescribeTapesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeTapes', describeTapesResponse_marker - An opaque string that can be used as part of a subsequent
DescribeTapes call to retrieve the next page of results.
If a response does not contain a marker, then there are no more results to be retrieved.
$sel:tapes:DescribeTapesResponse', describeTapesResponse_tapes - An array of virtual tape descriptions.
$sel:httpStatus:DescribeTapesResponse', describeTapesResponse_httpStatus - The response's http status code.
DescribeStorediSCSIVolumes
data DescribeStorediSCSIVolumes Source #
A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
See: newDescribeStorediSCSIVolumes smart constructor.
Constructors
| DescribeStorediSCSIVolumes' [Text] |
Instances
newDescribeStorediSCSIVolumes :: DescribeStorediSCSIVolumes Source #
Create a value of DescribeStorediSCSIVolumes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeARNs:DescribeStorediSCSIVolumes', describeStorediSCSIVolumes_volumeARNs - An array of strings where each string represents the Amazon Resource
Name (ARN) of a stored volume. All of the specified stored volumes must
be from the same gateway. Use ListVolumes to get volume ARNs for a
gateway.
data DescribeStorediSCSIVolumesResponse Source #
See: newDescribeStorediSCSIVolumesResponse smart constructor.
Constructors
| DescribeStorediSCSIVolumesResponse' (Maybe [StorediSCSIVolume]) Int |
Instances
newDescribeStorediSCSIVolumesResponse Source #
Arguments
| :: Int | |
| -> DescribeStorediSCSIVolumesResponse |
Create a value of DescribeStorediSCSIVolumesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:storediSCSIVolumes:DescribeStorediSCSIVolumesResponse', describeStorediSCSIVolumesResponse_storediSCSIVolumes - Describes a single unit of output from DescribeStorediSCSIVolumes. The
following fields are returned:
ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.LunNumber: The logical disk number.NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.NetworkInterfacePort: The port used to communicate with iSCSI targets.PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying local disk was preserved.SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g.snap-1122aabb. Otherwise, this field is not included.StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.TargetARN: The Amazon Resource Name (ARN) of the volume target.VolumeARN: The Amazon Resource Name (ARN) of the stored volume.VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.VolumeId: The unique identifier of the storage volume, e.g.vol-1122AABB.VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.VolumeSizeInBytes: The size of the volume in bytes.VolumeStatus: One of theVolumeStatusvalues that indicates the state of the volume.VolumeType: One of the enumeration values describing the type of the volume. Currently, onlySTOREDvolumes are supported.
$sel:httpStatus:DescribeStorediSCSIVolumesResponse', describeStorediSCSIVolumesResponse_httpStatus - The response's http status code.
DisassociateFileSystem
data DisassociateFileSystem Source #
See: newDisassociateFileSystem smart constructor.
Constructors
| DisassociateFileSystem' (Maybe Bool) Text |
Instances
newDisassociateFileSystem Source #
Create a value of DisassociateFileSystem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forceDelete:DisassociateFileSystem', disassociateFileSystem_forceDelete - If this value is set to true, the operation disassociates an Amazon FSx
file system immediately. It ends all data uploads to the file system,
and the file system association enters the FORCE_DELETING status. If
this value is set to false, the Amazon FSx file system does not
disassociate until all data is uploaded.
$sel:fileSystemAssociationARN:DisassociateFileSystem', disassociateFileSystem_fileSystemAssociationARN - The Amazon Resource Name (ARN) of the file system association to be
deleted.
data DisassociateFileSystemResponse Source #
See: newDisassociateFileSystemResponse smart constructor.
Constructors
| DisassociateFileSystemResponse' (Maybe Text) Int |
Instances
newDisassociateFileSystemResponse Source #
Create a value of DisassociateFileSystemResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystemAssociationARN:DisassociateFileSystem', disassociateFileSystemResponse_fileSystemAssociationARN - The Amazon Resource Name (ARN) of the deleted file system association.
$sel:httpStatus:DisassociateFileSystemResponse', disassociateFileSystemResponse_httpStatus - The response's http status code.
SetSMBGuestPassword
data SetSMBGuestPassword Source #
SetSMBGuestPasswordInput
See: newSetSMBGuestPassword smart constructor.
Constructors
| SetSMBGuestPassword' Text (Sensitive Text) |
Instances
newSetSMBGuestPassword Source #
Arguments
| :: Text | |
| -> Text | |
| -> SetSMBGuestPassword |
Create a value of SetSMBGuestPassword with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:SetSMBGuestPassword', setSMBGuestPassword_gatewayARN - The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file share
is associated with.
$sel:password:SetSMBGuestPassword', setSMBGuestPassword_password - The password that you want to set for your SMB server.
data SetSMBGuestPasswordResponse Source #
See: newSetSMBGuestPasswordResponse smart constructor.
Constructors
| SetSMBGuestPasswordResponse' (Maybe Text) Int |
Instances
newSetSMBGuestPasswordResponse Source #
Create a value of SetSMBGuestPasswordResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:SetSMBGuestPassword', setSMBGuestPasswordResponse_gatewayARN - Undocumented member.
$sel:httpStatus:SetSMBGuestPasswordResponse', setSMBGuestPasswordResponse_httpStatus - The response's http status code.
CreateSnapshotFromVolumeRecoveryPoint
data CreateSnapshotFromVolumeRecoveryPoint Source #
See: newCreateSnapshotFromVolumeRecoveryPoint smart constructor.
Constructors
| CreateSnapshotFromVolumeRecoveryPoint' (Maybe [Tag]) Text Text |
Instances
newCreateSnapshotFromVolumeRecoveryPoint Source #
Arguments
| :: Text | |
| -> Text |
|
| -> CreateSnapshotFromVolumeRecoveryPoint |
Create a value of CreateSnapshotFromVolumeRecoveryPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateSnapshotFromVolumeRecoveryPoint', createSnapshotFromVolumeRecoveryPoint_tags - A list of up to 50 tags that can be assigned to a snapshot. Each tag is
a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
$sel:volumeARN:CreateSnapshotFromVolumeRecoveryPoint', createSnapshotFromVolumeRecoveryPoint_volumeARN - The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN
for specified VolumeARN.
$sel:snapshotDescription:CreateSnapshotFromVolumeRecoveryPoint', createSnapshotFromVolumeRecoveryPoint_snapshotDescription - Textual description of the snapshot that appears in the Amazon EC2
console, Elastic Block Store snapshots panel in the Description
field, and in the Storage Gateway snapshot Details pane,
Description field.
data CreateSnapshotFromVolumeRecoveryPointResponse Source #
See: newCreateSnapshotFromVolumeRecoveryPointResponse smart constructor.
Constructors
| CreateSnapshotFromVolumeRecoveryPointResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newCreateSnapshotFromVolumeRecoveryPointResponse Source #
Arguments
| :: Int |
|
| -> CreateSnapshotFromVolumeRecoveryPointResponse |
Create a value of CreateSnapshotFromVolumeRecoveryPointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeRecoveryPointTime:CreateSnapshotFromVolumeRecoveryPointResponse', createSnapshotFromVolumeRecoveryPointResponse_volumeRecoveryPointTime - The time the volume was created from the recovery point.
$sel:volumeARN:CreateSnapshotFromVolumeRecoveryPoint', createSnapshotFromVolumeRecoveryPointResponse_volumeARN - The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN
for specified VolumeARN.
$sel:snapshotId:CreateSnapshotFromVolumeRecoveryPointResponse', createSnapshotFromVolumeRecoveryPointResponse_snapshotId - The ID of the snapshot.
$sel:httpStatus:CreateSnapshotFromVolumeRecoveryPointResponse', createSnapshotFromVolumeRecoveryPointResponse_httpStatus - The response's http status code.
RetrieveTapeRecoveryPoint
data RetrieveTapeRecoveryPoint Source #
RetrieveTapeRecoveryPointInput
See: newRetrieveTapeRecoveryPoint smart constructor.
Constructors
| RetrieveTapeRecoveryPoint' Text Text |
Instances
newRetrieveTapeRecoveryPoint Source #
Arguments
| :: Text | |
| -> Text | |
| -> RetrieveTapeRecoveryPoint |
Create a value of RetrieveTapeRecoveryPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeARN:RetrieveTapeRecoveryPoint', retrieveTapeRecoveryPoint_tapeARN - The Amazon Resource Name (ARN) of the virtual tape for which you want to
retrieve the recovery point.
$sel:gatewayARN:RetrieveTapeRecoveryPoint', retrieveTapeRecoveryPoint_gatewayARN - Undocumented member.
data RetrieveTapeRecoveryPointResponse Source #
RetrieveTapeRecoveryPointOutput
See: newRetrieveTapeRecoveryPointResponse smart constructor.
Constructors
| RetrieveTapeRecoveryPointResponse' (Maybe Text) Int |
Instances
newRetrieveTapeRecoveryPointResponse Source #
Arguments
| :: Int | |
| -> RetrieveTapeRecoveryPointResponse |
Create a value of RetrieveTapeRecoveryPointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeARN:RetrieveTapeRecoveryPoint', retrieveTapeRecoveryPointResponse_tapeARN - The Amazon Resource Name (ARN) of the virtual tape for which the
recovery point was retrieved.
$sel:httpStatus:RetrieveTapeRecoveryPointResponse', retrieveTapeRecoveryPointResponse_httpStatus - The response's http status code.
AddTagsToResource
data AddTagsToResource Source #
AddTagsToResourceInput
See: newAddTagsToResource smart constructor.
Constructors
| AddTagsToResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> AddTagsToResource |
Create a value of AddTagsToResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:AddTagsToResource', addTagsToResource_resourceARN - The Amazon Resource Name (ARN) of the resource you want to add tags to.
$sel:tags:AddTagsToResource', addTagsToResource_tags - The key-value pair that represents the tag you want to add to the
resource. The value can be an empty string.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
data AddTagsToResourceResponse Source #
AddTagsToResourceOutput
See: newAddTagsToResourceResponse smart constructor.
Constructors
| AddTagsToResourceResponse' (Maybe Text) Int |
Instances
newAddTagsToResourceResponse Source #
Create a value of AddTagsToResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:AddTagsToResource', addTagsToResourceResponse_resourceARN - The Amazon Resource Name (ARN) of the resource you want to add tags to.
$sel:httpStatus:AddTagsToResourceResponse', addTagsToResourceResponse_httpStatus - The response's http status code.
DeleteGateway
data DeleteGateway Source #
A JSON object containing the ID of the gateway to delete.
See: newDeleteGateway smart constructor.
Constructors
| DeleteGateway' Text |
Instances
Arguments
| :: Text | |
| -> DeleteGateway |
Create a value of DeleteGateway with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DeleteGateway', deleteGateway_gatewayARN - Undocumented member.
data DeleteGatewayResponse Source #
A JSON object containing the ID of the deleted gateway.
See: newDeleteGatewayResponse smart constructor.
Constructors
| DeleteGatewayResponse' (Maybe Text) Int |
Instances
newDeleteGatewayResponse Source #
Create a value of DeleteGatewayResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DeleteGateway', deleteGatewayResponse_gatewayARN - Undocumented member.
$sel:httpStatus:DeleteGatewayResponse', deleteGatewayResponse_httpStatus - The response's http status code.
UpdateMaintenanceStartTime
data UpdateMaintenanceStartTime Source #
A JSON object containing the following fields:
- UpdateMaintenanceStartTimeInput$DayOfMonth
- UpdateMaintenanceStartTimeInput$DayOfWeek
- UpdateMaintenanceStartTimeInput$HourOfDay
- UpdateMaintenanceStartTimeInput$MinuteOfHour
See: newUpdateMaintenanceStartTime smart constructor.
Instances
newUpdateMaintenanceStartTime Source #
Arguments
| :: Text | |
| -> Natural | |
| -> Natural | |
| -> UpdateMaintenanceStartTime |
Create a value of UpdateMaintenanceStartTime with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dayOfMonth:UpdateMaintenanceStartTime', updateMaintenanceStartTime_dayOfMonth - The day of the month component of the maintenance start time represented
as an ordinal number from 1 to 28, where 1 represents the first day of
the month and 28 represents the last day of the month.
$sel:dayOfWeek:UpdateMaintenanceStartTime', updateMaintenanceStartTime_dayOfWeek - The day of the week component of the maintenance start time week
represented as an ordinal number from 0 to 6, where 0 represents Sunday
and 6 Saturday.
$sel:gatewayARN:UpdateMaintenanceStartTime', updateMaintenanceStartTime_gatewayARN - Undocumented member.
$sel:hourOfDay:UpdateMaintenanceStartTime', updateMaintenanceStartTime_hourOfDay - The hour component of the maintenance start time represented as hh,
where hh is the hour (00 to 23). The hour of the day is in the time
zone of the gateway.
$sel:minuteOfHour:UpdateMaintenanceStartTime', updateMaintenanceStartTime_minuteOfHour - The minute component of the maintenance start time represented as mm,
where mm is the minute (00 to 59). The minute of the hour is in the
time zone of the gateway.
data UpdateMaintenanceStartTimeResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose maintenance start time is updated.
See: newUpdateMaintenanceStartTimeResponse smart constructor.
Constructors
| UpdateMaintenanceStartTimeResponse' (Maybe Text) Int |
Instances
newUpdateMaintenanceStartTimeResponse Source #
Arguments
| :: Int | |
| -> UpdateMaintenanceStartTimeResponse |
Create a value of UpdateMaintenanceStartTimeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateMaintenanceStartTime', updateMaintenanceStartTimeResponse_gatewayARN - Undocumented member.
$sel:httpStatus:UpdateMaintenanceStartTimeResponse', updateMaintenanceStartTimeResponse_httpStatus - The response's http status code.
DescribeGatewayInformation
data DescribeGatewayInformation Source #
A JSON object containing the ID of the gateway.
See: newDescribeGatewayInformation smart constructor.
Constructors
| DescribeGatewayInformation' Text |
Instances
newDescribeGatewayInformation Source #
Create a value of DescribeGatewayInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeGatewayInformation', describeGatewayInformation_gatewayARN - Undocumented member.
data DescribeGatewayInformationResponse Source #
A JSON object containing the following fields:
See: newDescribeGatewayInformationResponse smart constructor.
Constructors
| DescribeGatewayInformationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [NetworkInterface]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe GatewayCapacity) (Maybe [GatewayCapacity]) (Maybe Text) (Maybe Text) (Maybe HostEnvironment) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Int |
Instances
newDescribeGatewayInformationResponse Source #
Arguments
| :: Int | |
| -> DescribeGatewayInformationResponse |
Create a value of DescribeGatewayInformationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayState:DescribeGatewayInformationResponse', describeGatewayInformationResponse_gatewayState - A value that indicates the operating state of the gateway.
$sel:ec2InstanceRegion:DescribeGatewayInformationResponse', describeGatewayInformationResponse_ec2InstanceRegion - The Region where the Amazon EC2 instance is located.
$sel:gatewayARN:DescribeGatewayInformation', describeGatewayInformationResponse_gatewayARN - Undocumented member.
$sel:gatewayNetworkInterfaces:DescribeGatewayInformationResponse', describeGatewayInformationResponse_gatewayNetworkInterfaces - A NetworkInterface array that contains descriptions of the gateway
network interfaces.
$sel:ec2InstanceId:DescribeGatewayInformationResponse', describeGatewayInformationResponse_ec2InstanceId - The ID of the Amazon EC2 instance that was used to launch the gateway.
$sel:nextUpdateAvailabilityDate:DescribeGatewayInformationResponse', describeGatewayInformationResponse_nextUpdateAvailabilityDate - The date on which an update to the gateway is available. This date is in
the time zone of the gateway. If the gateway is not available for an
update this field is not returned in the response.
$sel:endpointType:DescribeGatewayInformationResponse', describeGatewayInformationResponse_endpointType - The type of endpoint for your gateway.
Valid Values: STANDARD | FIPS
$sel:deprecationDate:DescribeGatewayInformationResponse', describeGatewayInformationResponse_deprecationDate - Date after which this gateway will not receive software updates for new
features and bug fixes.
$sel:lastSoftwareUpdate:DescribeGatewayInformationResponse', describeGatewayInformationResponse_lastSoftwareUpdate - The date on which the last software update was applied to the gateway.
If the gateway has never been updated, this field does not return a
value in the response.
$sel:gatewayCapacity:DescribeGatewayInformationResponse', describeGatewayInformationResponse_gatewayCapacity - Specifies the size of the gateway's metadata cache.
$sel:supportedGatewayCapacities:DescribeGatewayInformationResponse', describeGatewayInformationResponse_supportedGatewayCapacities - A list of the metadata cache sizes that the gateway can support based on
its current hardware specifications.
$sel:gatewayName:DescribeGatewayInformationResponse', describeGatewayInformationResponse_gatewayName - The name you configured for your gateway.
$sel:gatewayId:DescribeGatewayInformationResponse', describeGatewayInformationResponse_gatewayId - The unique identifier assigned to your gateway during activation. This
ID becomes part of the gateway Amazon Resource Name (ARN), which you use
as input for other operations.
$sel:hostEnvironment:DescribeGatewayInformationResponse', describeGatewayInformationResponse_hostEnvironment - The type of hypervisor environment used by the host.
$sel:gatewayType:DescribeGatewayInformationResponse', describeGatewayInformationResponse_gatewayType - The type of the gateway.
$sel:gatewayTimezone:DescribeGatewayInformationResponse', describeGatewayInformationResponse_gatewayTimezone - A value that indicates the time zone configured for the gateway.
$sel:softwareUpdatesEndDate:DescribeGatewayInformationResponse', describeGatewayInformationResponse_softwareUpdatesEndDate - Date after which this gateway will not receive software updates for new
features.
$sel:cloudWatchLogGroupARN:DescribeGatewayInformationResponse', describeGatewayInformationResponse_cloudWatchLogGroupARN - The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
is used to monitor events in the gateway.
$sel:vPCEndpoint:DescribeGatewayInformationResponse', describeGatewayInformationResponse_vPCEndpoint - The configuration settings for the virtual private cloud (VPC) endpoint
for your gateway.
$sel:tags:DescribeGatewayInformationResponse', describeGatewayInformationResponse_tags - A list of up to 50 tags assigned to the gateway, sorted alphabetically
by key name. Each tag is a key-value pair. For a gateway with more than
10 tags assigned, you can view all tags using the ListTagsForResource
API operation.
$sel:httpStatus:DescribeGatewayInformationResponse', describeGatewayInformationResponse_httpStatus - The response's http status code.
RefreshCache
data RefreshCache Source #
RefreshCacheInput
See: newRefreshCache smart constructor.
Instances
Arguments
| :: Text | |
| -> RefreshCache |
Create a value of RefreshCache with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:folderList:RefreshCache', refreshCache_folderList - A comma-separated list of the paths of folders to refresh in the cache.
The default is ["/"]. The default refreshes objects and folders at
the root of the Amazon S3 bucket. If Recursive is set to true, the
entire S3 bucket that the file share has access to is refreshed.
$sel:recursive:RefreshCache', refreshCache_recursive - A value that specifies whether to recursively refresh folders in the
cache. The refresh includes folders that were in the cache the last time
the gateway listed the folder's contents. If this value set to true,
each folder that is listed in FolderList is recursively updated.
Otherwise, subfolders listed in FolderList are not refreshed. Only
objects that are in folders listed directly under FolderList are found
and used for the update. The default is true.
Valid Values: true | false
$sel:fileShareARN:RefreshCache', refreshCache_fileShareARN - The Amazon Resource Name (ARN) of the file share you want to refresh.
data RefreshCacheResponse Source #
RefreshCacheOutput
See: newRefreshCacheResponse smart constructor.
Instances
newRefreshCacheResponse Source #
Arguments
| :: Int | |
| -> RefreshCacheResponse |
Create a value of RefreshCacheResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareARN:RefreshCache', refreshCacheResponse_fileShareARN - Undocumented member.
$sel:notificationId:RefreshCacheResponse', refreshCacheResponse_notificationId - Undocumented member.
$sel:httpStatus:RefreshCacheResponse', refreshCacheResponse_httpStatus - The response's http status code.
UpdateNFSFileShare
data UpdateNFSFileShare Source #
UpdateNFSFileShareInput
See: newUpdateNFSFileShare smart constructor.
Constructors
| UpdateNFSFileShare' (Maybe Text) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NFSFileShareDefaults) (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe Bool) Text |
Instances
newUpdateNFSFileShare Source #
Arguments
| :: Text | |
| -> UpdateNFSFileShare |
Create a value of UpdateNFSFileShare with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:UpdateNFSFileShare', updateNFSFileShare_kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
used for Amazon S3 server-side encryption. Storage Gateway does not
support asymmetric CMKs. This value can only be set when KMSEncrypted
is true. Optional.
$sel:cacheAttributes:UpdateNFSFileShare', updateNFSFileShare_cacheAttributes - specifies refresh cache information for the file share.
$sel:objectACL:UpdateNFSFileShare', updateNFSFileShare_objectACL - A value that sets the access control list (ACL) permission for objects
in the S3 bucket that a S3 File Gateway puts objects into. The default
value is private.
$sel:kmsEncrypted:UpdateNFSFileShare', updateNFSFileShare_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
$sel:defaultStorageClass:UpdateNFSFileShare', updateNFSFileShare_defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by
the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING.
Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |
S3_STANDARD_IA | S3_ONEZONE_IA
$sel:fileShareName:UpdateNFSFileShare', updateNFSFileShare_fileShareName - The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in
LocationARN.
$sel:notificationPolicy:UpdateNFSFileShare', updateNFSFileShare_notificationPolicy - The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a
client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's
best to set this parameter for as long as possible to avoid generating
multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object
uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with
SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}The following example sets NotificationPolicy off.
{}$sel:squash:UpdateNFSFileShare', updateNFSFileShare_squash - The user mapped to anonymous user.
Valid values are the following:
RootSquash: Only root is mapped to anonymous user.NoSquash: No one is mapped to anonymous user.AllSquash: Everyone is mapped to anonymous user.
$sel:requesterPays:UpdateNFSFileShare', updateNFSFileShare_requesterPays - A value that sets who pays the cost of the request and the cost
associated with data download from the S3 bucket. If this value is set
to true, the requester pays the costs; otherwise, the S3 bucket owner
pays. However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file
share, so make sure that the configuration on the file share is the same
as the S3 bucket configuration.
Valid Values: true | false
$sel:nFSFileShareDefaults:UpdateNFSFileShare', updateNFSFileShare_nFSFileShareDefaults - The default values for the file share. Optional.
$sel:clientList:UpdateNFSFileShare', updateNFSFileShare_clientList - The list of clients that are allowed to access the S3 File Gateway. The
list must contain either valid IP addresses or valid CIDR blocks.
$sel:guessMIMETypeEnabled:UpdateNFSFileShare', updateNFSFileShare_guessMIMETypeEnabled - A value that enables guessing of the MIME type for uploaded objects
based on file extensions. Set this value to true to enable MIME type
guessing, otherwise set to false. The default value is true.
Valid Values: true | false
$sel:readOnly:UpdateNFSFileShare', updateNFSFileShare_readOnly - A value that sets the write status of a file share. Set this value to
true to set the write status to read-only, otherwise set to false.
Valid Values: true | false
$sel:fileShareARN:UpdateNFSFileShare', updateNFSFileShare_fileShareARN - The Amazon Resource Name (ARN) of the file share to be updated.
data UpdateNFSFileShareResponse Source #
UpdateNFSFileShareOutput
See: newUpdateNFSFileShareResponse smart constructor.
Constructors
| UpdateNFSFileShareResponse' (Maybe Text) Int |
Instances
newUpdateNFSFileShareResponse Source #
Create a value of UpdateNFSFileShareResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareARN:UpdateNFSFileShare', updateNFSFileShareResponse_fileShareARN - The Amazon Resource Name (ARN) of the updated file share.
$sel:httpStatus:UpdateNFSFileShareResponse', updateNFSFileShareResponse_httpStatus - The response's http status code.
RetrieveTapeArchive
data RetrieveTapeArchive Source #
RetrieveTapeArchiveInput
See: newRetrieveTapeArchive smart constructor.
Constructors
| RetrieveTapeArchive' Text Text |
Instances
newRetrieveTapeArchive Source #
Arguments
| :: Text | |
| -> Text | |
| -> RetrieveTapeArchive |
Create a value of RetrieveTapeArchive with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeARN:RetrieveTapeArchive', retrieveTapeArchive_tapeARN - The Amazon Resource Name (ARN) of the virtual tape you want to retrieve
from the virtual tape shelf (VTS).
$sel:gatewayARN:RetrieveTapeArchive', retrieveTapeArchive_gatewayARN - The Amazon Resource Name (ARN) of the gateway you want to retrieve the
virtual tape to. Use the ListGateways operation to return a list of
gateways for your account and Region.
You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.
data RetrieveTapeArchiveResponse Source #
RetrieveTapeArchiveOutput
See: newRetrieveTapeArchiveResponse smart constructor.
Constructors
| RetrieveTapeArchiveResponse' (Maybe Text) Int |
Instances
newRetrieveTapeArchiveResponse Source #
Create a value of RetrieveTapeArchiveResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeARN:RetrieveTapeArchive', retrieveTapeArchiveResponse_tapeARN - The Amazon Resource Name (ARN) of the retrieved virtual tape.
$sel:httpStatus:RetrieveTapeArchiveResponse', retrieveTapeArchiveResponse_httpStatus - The response's http status code.
DescribeTapeArchives (Paginated)
data DescribeTapeArchives Source #
DescribeTapeArchivesInput
See: newDescribeTapeArchives smart constructor.
Instances
newDescribeTapeArchives :: DescribeTapeArchives Source #
Create a value of DescribeTapeArchives with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeTapeArchives', describeTapeArchives_marker - An opaque string that indicates the position at which to begin
describing virtual tapes.
$sel:limit:DescribeTapeArchives', describeTapeArchives_limit - Specifies that the number of virtual tapes described be limited to the
specified number.
$sel:tapeARNs:DescribeTapeArchives', describeTapeArchives_tapeARNs - Specifies one or more unique Amazon Resource Names (ARNs) that represent
the virtual tapes you want to describe.
data DescribeTapeArchivesResponse Source #
DescribeTapeArchivesOutput
See: newDescribeTapeArchivesResponse smart constructor.
Constructors
| DescribeTapeArchivesResponse' (Maybe [TapeArchive]) (Maybe Text) Int |
Instances
newDescribeTapeArchivesResponse Source #
Create a value of DescribeTapeArchivesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeArchives:DescribeTapeArchivesResponse', describeTapeArchivesResponse_tapeArchives - An array of virtual tape objects in the virtual tape shelf (VTS). The
description includes of the Amazon Resource Name (ARN) of the virtual
tapes. The information returned includes the Amazon Resource Names
(ARNs) of the tapes, size of the tapes, status of the tapes, progress of
the description, and tape barcode.
$sel:marker:DescribeTapeArchives', describeTapeArchivesResponse_marker - An opaque string that indicates the position at which the virtual tapes
that were fetched for description ended. Use this marker in your next
request to fetch the next set of virtual tapes in the virtual tape shelf
(VTS). If there are no more virtual tapes to describe, this field does
not appear in the response.
$sel:httpStatus:DescribeTapeArchivesResponse', describeTapeArchivesResponse_httpStatus - The response's http status code.
UpdateBandwidthRateLimitSchedule
data UpdateBandwidthRateLimitSchedule Source #
See: newUpdateBandwidthRateLimitSchedule smart constructor.
Constructors
| UpdateBandwidthRateLimitSchedule' Text [BandwidthRateLimitInterval] |
Instances
newUpdateBandwidthRateLimitSchedule Source #
Arguments
| :: Text | |
| -> UpdateBandwidthRateLimitSchedule |
Create a value of UpdateBandwidthRateLimitSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateBandwidthRateLimitSchedule', updateBandwidthRateLimitSchedule_gatewayARN - Undocumented member.
$sel:bandwidthRateLimitIntervals:UpdateBandwidthRateLimitSchedule', updateBandwidthRateLimitSchedule_bandwidthRateLimitIntervals - An array containing bandwidth rate limit schedule intervals for a
gateway. When no bandwidth rate limit intervals have been scheduled, the
array is empty.
data UpdateBandwidthRateLimitScheduleResponse Source #
See: newUpdateBandwidthRateLimitScheduleResponse smart constructor.
Constructors
| UpdateBandwidthRateLimitScheduleResponse' (Maybe Text) Int |
Instances
newUpdateBandwidthRateLimitScheduleResponse Source #
Arguments
| :: Int | |
| -> UpdateBandwidthRateLimitScheduleResponse |
Create a value of UpdateBandwidthRateLimitScheduleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateBandwidthRateLimitSchedule', updateBandwidthRateLimitScheduleResponse_gatewayARN - Undocumented member.
$sel:httpStatus:UpdateBandwidthRateLimitScheduleResponse', updateBandwidthRateLimitScheduleResponse_httpStatus - The response's http status code.
DisableGateway
data DisableGateway Source #
DisableGatewayInput
See: newDisableGateway smart constructor.
Constructors
| DisableGateway' Text |
Instances
Arguments
| :: Text | |
| -> DisableGateway |
Create a value of DisableGateway with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DisableGateway', disableGateway_gatewayARN - Undocumented member.
data DisableGatewayResponse Source #
DisableGatewayOutput
See: newDisableGatewayResponse smart constructor.
Constructors
| DisableGatewayResponse' (Maybe Text) Int |
Instances
newDisableGatewayResponse Source #
Create a value of DisableGatewayResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DisableGateway', disableGatewayResponse_gatewayARN - The unique Amazon Resource Name (ARN) of the disabled gateway.
$sel:httpStatus:DisableGatewayResponse', disableGatewayResponse_httpStatus - The response's http status code.
DescribeSMBSettings
data DescribeSMBSettings Source #
See: newDescribeSMBSettings smart constructor.
Constructors
| DescribeSMBSettings' Text |
Instances
newDescribeSMBSettings Source #
Arguments
| :: Text | |
| -> DescribeSMBSettings |
Create a value of DescribeSMBSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeSMBSettings', describeSMBSettings_gatewayARN - Undocumented member.
data DescribeSMBSettingsResponse Source #
See: newDescribeSMBSettingsResponse smart constructor.
Constructors
| DescribeSMBSettingsResponse' (Maybe Text) (Maybe Bool) (Maybe ActiveDirectoryStatus) (Maybe Text) (Maybe Bool) (Maybe SMBSecurityStrategy) Int |
Instances
newDescribeSMBSettingsResponse Source #
Create a value of DescribeSMBSettingsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeSMBSettings', describeSMBSettingsResponse_gatewayARN - Undocumented member.
$sel:fileSharesVisible:DescribeSMBSettingsResponse', describeSMBSettingsResponse_fileSharesVisible - The shares on this gateway appear when listing shares. Only supported
for S3 File Gateways.
$sel:activeDirectoryStatus:DescribeSMBSettingsResponse', describeSMBSettingsResponse_activeDirectoryStatus - Indicates the status of a gateway that is a member of the Active
Directory domain.
ACCESS_DENIED: Indicates that theJoinDomainoperation failed due to an authentication error.DETACHED: Indicates that gateway is not joined to a domain.JOINED: Indicates that the gateway has successfully joined a domain.JOINING: Indicates that aJoinDomainoperation is in progress.NETWORK_ERROR: Indicates thatJoinDomainoperation failed due to a network or connectivity error.TIMEOUT: Indicates that theJoinDomainoperation failed because the operation didn't complete within the allotted time.UNKNOWN_ERROR: Indicates that theJoinDomainoperation failed due to another type of error.
$sel:domainName:DescribeSMBSettingsResponse', describeSMBSettingsResponse_domainName - The name of the domain that the gateway is joined to.
$sel:sMBGuestPasswordSet:DescribeSMBSettingsResponse', describeSMBSettingsResponse_sMBGuestPasswordSet - This value is true if a password for the guest user smbguest is set,
otherwise false. Only supported for S3 File Gateways.
Valid Values: true | false
$sel:sMBSecurityStrategy:DescribeSMBSettingsResponse', describeSMBSettingsResponse_sMBSecurityStrategy - The type of security strategy that was specified for file gateway.
ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.
$sel:httpStatus:DescribeSMBSettingsResponse', describeSMBSettingsResponse_httpStatus - The response's http status code.
DescribeSnapshotSchedule
data DescribeSnapshotSchedule Source #
A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.
See: newDescribeSnapshotSchedule smart constructor.
Constructors
| DescribeSnapshotSchedule' Text |
Instances
newDescribeSnapshotSchedule Source #
Create a value of DescribeSnapshotSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeARN:DescribeSnapshotSchedule', describeSnapshotSchedule_volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
operation to return a list of gateway volumes.
data DescribeSnapshotScheduleResponse Source #
See: newDescribeSnapshotScheduleResponse smart constructor.
Constructors
| DescribeSnapshotScheduleResponse' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe [Tag]) Int |
Instances
newDescribeSnapshotScheduleResponse Source #
Create a value of DescribeSnapshotScheduleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startAt:DescribeSnapshotScheduleResponse', describeSnapshotScheduleResponse_startAt - The hour of the day at which the snapshot schedule begins represented as
hh, where hh is the hour (0 to 23). The hour of the day is in the
time zone of the gateway.
$sel:volumeARN:DescribeSnapshotSchedule', describeSnapshotScheduleResponse_volumeARN - The Amazon Resource Name (ARN) of the volume that was specified in the
request.
$sel:recurrenceInHours:DescribeSnapshotScheduleResponse', describeSnapshotScheduleResponse_recurrenceInHours - The number of hours between snapshots.
$sel:timezone:DescribeSnapshotScheduleResponse', describeSnapshotScheduleResponse_timezone - A value that indicates the time zone of the gateway.
$sel:description:DescribeSnapshotScheduleResponse', describeSnapshotScheduleResponse_description - The snapshot description.
$sel:tags:DescribeSnapshotScheduleResponse', describeSnapshotScheduleResponse_tags - A list of up to 50 tags assigned to the snapshot schedule, sorted
alphabetically by key name. Each tag is a key-value pair. For a gateway
with more than 10 tags assigned, you can view all tags using the
ListTagsForResource API operation.
$sel:httpStatus:DescribeSnapshotScheduleResponse', describeSnapshotScheduleResponse_httpStatus - The response's http status code.
CreateTapeWithBarcode
data CreateTapeWithBarcode Source #
CreateTapeWithBarcodeInput
See: newCreateTapeWithBarcode smart constructor.
Constructors
| CreateTapeWithBarcode' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe [Tag]) Text Integer Text |
Instances
newCreateTapeWithBarcode Source #
Arguments
| :: Text | |
| -> Integer | |
| -> Text | |
| -> CreateTapeWithBarcode |
Create a value of CreateTapeWithBarcode with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:CreateTapeWithBarcode', createTapeWithBarcode_kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
used for Amazon S3 server-side encryption. Storage Gateway does not
support asymmetric CMKs. This value can only be set when KMSEncrypted
is true. Optional.
$sel:kmsEncrypted:CreateTapeWithBarcode', createTapeWithBarcode_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
$sel:poolId:CreateTapeWithBarcode', createTapeWithBarcode_poolId - The ID of the pool that you want to add your tape to for archiving. The
tape in this pool is archived in the S3 storage class that is associated
with the pool. When you use your backup application to eject the tape,
the tape is archived directly into the storage class (S3 Glacier or S3
Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
$sel:worm:CreateTapeWithBarcode', createTapeWithBarcode_worm - Set to TRUE if the tape you are creating is to be configured as a
write-once-read-many (WORM) tape.
$sel:tags:CreateTapeWithBarcode', createTapeWithBarcode_tags - A list of up to 50 tags that can be assigned to a virtual tape that has
a barcode. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
$sel:gatewayARN:CreateTapeWithBarcode', createTapeWithBarcode_gatewayARN - The unique Amazon Resource Name (ARN) that represents the gateway to
associate the virtual tape with. Use the ListGateways operation to
return a list of gateways for your account and Region.
$sel:tapeSizeInBytes:CreateTapeWithBarcode', createTapeWithBarcode_tapeSizeInBytes - The size, in bytes, of the virtual tape that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
$sel:tapeBarcode:CreateTapeWithBarcode', createTapeWithBarcode_tapeBarcode - The barcode that you want to assign to the tape.
Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
data CreateTapeWithBarcodeResponse Source #
CreateTapeOutput
See: newCreateTapeWithBarcodeResponse smart constructor.
Constructors
| CreateTapeWithBarcodeResponse' (Maybe Text) Int |
Instances
newCreateTapeWithBarcodeResponse Source #
Create a value of CreateTapeWithBarcodeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeARN:CreateTapeWithBarcodeResponse', createTapeWithBarcodeResponse_tapeARN - A unique Amazon Resource Name (ARN) that represents the virtual tape
that was created.
$sel:httpStatus:CreateTapeWithBarcodeResponse', createTapeWithBarcodeResponse_httpStatus - The response's http status code.
DescribeBandwidthRateLimit
data DescribeBandwidthRateLimit Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
See: newDescribeBandwidthRateLimit smart constructor.
Constructors
| DescribeBandwidthRateLimit' Text |
Instances
newDescribeBandwidthRateLimit Source #
Create a value of DescribeBandwidthRateLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeBandwidthRateLimit', describeBandwidthRateLimit_gatewayARN - Undocumented member.
data DescribeBandwidthRateLimitResponse Source #
A JSON object containing the following fields:
See: newDescribeBandwidthRateLimitResponse smart constructor.
Instances
newDescribeBandwidthRateLimitResponse Source #
Arguments
| :: Int | |
| -> DescribeBandwidthRateLimitResponse |
Create a value of DescribeBandwidthRateLimitResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeBandwidthRateLimit', describeBandwidthRateLimitResponse_gatewayARN - Undocumented member.
$sel:averageUploadRateLimitInBitsPerSec:DescribeBandwidthRateLimitResponse', describeBandwidthRateLimitResponse_averageUploadRateLimitInBitsPerSec - The average upload bandwidth rate limit in bits per second. This field
does not appear in the response if the upload rate limit is not set.
$sel:averageDownloadRateLimitInBitsPerSec:DescribeBandwidthRateLimitResponse', describeBandwidthRateLimitResponse_averageDownloadRateLimitInBitsPerSec - The average download bandwidth rate limit in bits per second. This field
does not appear in the response if the download rate limit is not set.
$sel:httpStatus:DescribeBandwidthRateLimitResponse', describeBandwidthRateLimitResponse_httpStatus - The response's http status code.
DeleteAutomaticTapeCreationPolicy
data DeleteAutomaticTapeCreationPolicy Source #
See: newDeleteAutomaticTapeCreationPolicy smart constructor.
Constructors
| DeleteAutomaticTapeCreationPolicy' Text |
Instances
newDeleteAutomaticTapeCreationPolicy Source #
Arguments
| :: Text | |
| -> DeleteAutomaticTapeCreationPolicy |
Create a value of DeleteAutomaticTapeCreationPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DeleteAutomaticTapeCreationPolicy', deleteAutomaticTapeCreationPolicy_gatewayARN - Undocumented member.
data DeleteAutomaticTapeCreationPolicyResponse Source #
See: newDeleteAutomaticTapeCreationPolicyResponse smart constructor.
Constructors
| DeleteAutomaticTapeCreationPolicyResponse' (Maybe Text) Int |
Instances
newDeleteAutomaticTapeCreationPolicyResponse Source #
Arguments
| :: Int | |
| -> DeleteAutomaticTapeCreationPolicyResponse |
Create a value of DeleteAutomaticTapeCreationPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DeleteAutomaticTapeCreationPolicy', deleteAutomaticTapeCreationPolicyResponse_gatewayARN - Undocumented member.
$sel:httpStatus:DeleteAutomaticTapeCreationPolicyResponse', deleteAutomaticTapeCreationPolicyResponse_httpStatus - The response's http status code.
UpdateAutomaticTapeCreationPolicy
data UpdateAutomaticTapeCreationPolicy Source #
See: newUpdateAutomaticTapeCreationPolicy smart constructor.
Instances
newUpdateAutomaticTapeCreationPolicy Source #
Arguments
| :: NonEmpty AutomaticTapeCreationRule |
|
| -> Text | |
| -> UpdateAutomaticTapeCreationPolicy |
Create a value of UpdateAutomaticTapeCreationPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automaticTapeCreationRules:UpdateAutomaticTapeCreationPolicy', updateAutomaticTapeCreationPolicy_automaticTapeCreationRules - An automatic tape creation policy consists of a list of automatic tape
creation rules. The rules determine when and how to automatically create
new tapes.
$sel:gatewayARN:UpdateAutomaticTapeCreationPolicy', updateAutomaticTapeCreationPolicy_gatewayARN - Undocumented member.
data UpdateAutomaticTapeCreationPolicyResponse Source #
See: newUpdateAutomaticTapeCreationPolicyResponse smart constructor.
Constructors
| UpdateAutomaticTapeCreationPolicyResponse' (Maybe Text) Int |
Instances
newUpdateAutomaticTapeCreationPolicyResponse Source #
Arguments
| :: Int | |
| -> UpdateAutomaticTapeCreationPolicyResponse |
Create a value of UpdateAutomaticTapeCreationPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateAutomaticTapeCreationPolicy', updateAutomaticTapeCreationPolicyResponse_gatewayARN - Undocumented member.
$sel:httpStatus:UpdateAutomaticTapeCreationPolicyResponse', updateAutomaticTapeCreationPolicyResponse_httpStatus - The response's http status code.
UpdateSMBFileShareVisibility
data UpdateSMBFileShareVisibility Source #
See: newUpdateSMBFileShareVisibility smart constructor.
Constructors
| UpdateSMBFileShareVisibility' Text Bool |
Instances
newUpdateSMBFileShareVisibility Source #
Arguments
| :: Text | |
| -> Bool | |
| -> UpdateSMBFileShareVisibility |
Create a value of UpdateSMBFileShareVisibility with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateSMBFileShareVisibility', updateSMBFileShareVisibility_gatewayARN - Undocumented member.
$sel:fileSharesVisible:UpdateSMBFileShareVisibility', updateSMBFileShareVisibility_fileSharesVisible - The shares on this gateway appear when listing shares.
data UpdateSMBFileShareVisibilityResponse Source #
See: newUpdateSMBFileShareVisibilityResponse smart constructor.
Constructors
| UpdateSMBFileShareVisibilityResponse' (Maybe Text) Int |
Instances
newUpdateSMBFileShareVisibilityResponse Source #
Arguments
| :: Int | |
| -> UpdateSMBFileShareVisibilityResponse |
Create a value of UpdateSMBFileShareVisibilityResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateSMBFileShareVisibility', updateSMBFileShareVisibilityResponse_gatewayARN - Undocumented member.
$sel:httpStatus:UpdateSMBFileShareVisibilityResponse', updateSMBFileShareVisibilityResponse_httpStatus - The response's http status code.
DeleteSnapshotSchedule
data DeleteSnapshotSchedule Source #
See: newDeleteSnapshotSchedule smart constructor.
Constructors
| DeleteSnapshotSchedule' Text |
Instances
newDeleteSnapshotSchedule Source #
Create a value of DeleteSnapshotSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeARN:DeleteSnapshotSchedule', deleteSnapshotSchedule_volumeARN - The volume which snapshot schedule to delete.
data DeleteSnapshotScheduleResponse Source #
See: newDeleteSnapshotScheduleResponse smart constructor.
Constructors
| DeleteSnapshotScheduleResponse' (Maybe Text) Int |
Instances
newDeleteSnapshotScheduleResponse Source #
Create a value of DeleteSnapshotScheduleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeARN:DeleteSnapshotSchedule', deleteSnapshotScheduleResponse_volumeARN - The volume which snapshot schedule was deleted.
$sel:httpStatus:DeleteSnapshotScheduleResponse', deleteSnapshotScheduleResponse_httpStatus - The response's http status code.
UpdateSnapshotSchedule
data UpdateSnapshotSchedule Source #
A JSON object containing one or more of the following fields:
- UpdateSnapshotScheduleInput$Description
- UpdateSnapshotScheduleInput$RecurrenceInHours
- UpdateSnapshotScheduleInput$StartAt
- UpdateSnapshotScheduleInput$VolumeARN
See: newUpdateSnapshotSchedule smart constructor.
Instances
newUpdateSnapshotSchedule Source #
Arguments
| :: Text | |
| -> Natural | |
| -> Natural | |
| -> UpdateSnapshotSchedule |
Create a value of UpdateSnapshotSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:UpdateSnapshotSchedule', updateSnapshotSchedule_description - Optional description of the snapshot that overwrites the existing
description.
$sel:tags:UpdateSnapshotSchedule', updateSnapshotSchedule_tags - A list of up to 50 tags that can be assigned to a snapshot. Each tag is
a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
$sel:volumeARN:UpdateSnapshotSchedule', updateSnapshotSchedule_volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
operation to return a list of gateway volumes.
$sel:startAt:UpdateSnapshotSchedule', updateSnapshotSchedule_startAt - The hour of the day at which the snapshot schedule begins represented as
hh, where hh is the hour (0 to 23). The hour of the day is in the
time zone of the gateway.
$sel:recurrenceInHours:UpdateSnapshotSchedule', updateSnapshotSchedule_recurrenceInHours - Frequency of snapshots. Specify the number of hours between snapshots.
data UpdateSnapshotScheduleResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the updated storage volume.
See: newUpdateSnapshotScheduleResponse smart constructor.
Constructors
| UpdateSnapshotScheduleResponse' (Maybe Text) Int |
Instances
newUpdateSnapshotScheduleResponse Source #
Create a value of UpdateSnapshotScheduleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeARN:UpdateSnapshotSchedule', updateSnapshotScheduleResponse_volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
operation to return a list of gateway volumes.
$sel:httpStatus:UpdateSnapshotScheduleResponse', updateSnapshotScheduleResponse_httpStatus - The response's http status code.
DescribeBandwidthRateLimitSchedule
data DescribeBandwidthRateLimitSchedule Source #
See: newDescribeBandwidthRateLimitSchedule smart constructor.
Constructors
| DescribeBandwidthRateLimitSchedule' Text |
Instances
newDescribeBandwidthRateLimitSchedule Source #
Arguments
| :: Text | |
| -> DescribeBandwidthRateLimitSchedule |
Create a value of DescribeBandwidthRateLimitSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeBandwidthRateLimitSchedule', describeBandwidthRateLimitSchedule_gatewayARN - Undocumented member.
data DescribeBandwidthRateLimitScheduleResponse Source #
See: newDescribeBandwidthRateLimitScheduleResponse smart constructor.
Constructors
| DescribeBandwidthRateLimitScheduleResponse' (Maybe Text) (Maybe [BandwidthRateLimitInterval]) Int |
Instances
newDescribeBandwidthRateLimitScheduleResponse Source #
Arguments
| :: Int | |
| -> DescribeBandwidthRateLimitScheduleResponse |
Create a value of DescribeBandwidthRateLimitScheduleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeBandwidthRateLimitSchedule', describeBandwidthRateLimitScheduleResponse_gatewayARN - Undocumented member.
$sel:bandwidthRateLimitIntervals:DescribeBandwidthRateLimitScheduleResponse', describeBandwidthRateLimitScheduleResponse_bandwidthRateLimitIntervals - An array that contains the bandwidth rate limit intervals for a tape or
volume gateway.
$sel:httpStatus:DescribeBandwidthRateLimitScheduleResponse', describeBandwidthRateLimitScheduleResponse_httpStatus - The response's http status code.
CreateSnapshot
data CreateSnapshot Source #
A JSON object containing one or more of the following fields:
- CreateSnapshotInput$SnapshotDescription
- CreateSnapshotInput$VolumeARN
See: newCreateSnapshot smart constructor.
Constructors
| CreateSnapshot' (Maybe [Tag]) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateSnapshot |
Create a value of CreateSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateSnapshot', createSnapshot_tags - A list of up to 50 tags that can be assigned to a snapshot. Each tag is
a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
$sel:volumeARN:CreateSnapshot', createSnapshot_volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
operation to return a list of gateway volumes.
$sel:snapshotDescription:CreateSnapshot', createSnapshot_snapshotDescription - Textual description of the snapshot that appears in the Amazon EC2
console, Elastic Block Store snapshots panel in the Description
field, and in the Storage Gateway snapshot Details pane,
Description field.
data CreateSnapshotResponse Source #
A JSON object containing the following fields:
See: newCreateSnapshotResponse smart constructor.
Instances
newCreateSnapshotResponse Source #
Create a value of CreateSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeARN:CreateSnapshot', createSnapshotResponse_volumeARN - The Amazon Resource Name (ARN) of the volume of which the snapshot was
taken.
$sel:snapshotId:CreateSnapshotResponse', createSnapshotResponse_snapshotId - The snapshot ID that is used to refer to the snapshot in future
operations such as describing snapshots (Amazon Elastic Compute Cloud
API DescribeSnapshots) or creating a volume from a snapshot
(CreateStorediSCSIVolume).
$sel:httpStatus:CreateSnapshotResponse', createSnapshotResponse_httpStatus - The response's http status code.
UpdateSMBSecurityStrategy
data UpdateSMBSecurityStrategy Source #
See: newUpdateSMBSecurityStrategy smart constructor.
Constructors
| UpdateSMBSecurityStrategy' Text SMBSecurityStrategy |
Instances
newUpdateSMBSecurityStrategy Source #
Arguments
| :: Text | |
| -> SMBSecurityStrategy | |
| -> UpdateSMBSecurityStrategy |
Create a value of UpdateSMBSecurityStrategy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateSMBSecurityStrategy', updateSMBSecurityStrategy_gatewayARN - Undocumented member.
$sel:sMBSecurityStrategy:UpdateSMBSecurityStrategy', updateSMBSecurityStrategy_sMBSecurityStrategy - Specifies the type of security strategy.
ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only in S3 File Gateway.
MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.
data UpdateSMBSecurityStrategyResponse Source #
See: newUpdateSMBSecurityStrategyResponse smart constructor.
Constructors
| UpdateSMBSecurityStrategyResponse' (Maybe Text) Int |
Instances
newUpdateSMBSecurityStrategyResponse Source #
Arguments
| :: Int | |
| -> UpdateSMBSecurityStrategyResponse |
Create a value of UpdateSMBSecurityStrategyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateSMBSecurityStrategy', updateSMBSecurityStrategyResponse_gatewayARN - Undocumented member.
$sel:httpStatus:UpdateSMBSecurityStrategyResponse', updateSMBSecurityStrategyResponse_httpStatus - The response's http status code.
CancelRetrieval
data CancelRetrieval Source #
CancelRetrievalInput
See: newCancelRetrieval smart constructor.
Constructors
| CancelRetrieval' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CancelRetrieval |
Create a value of CancelRetrieval with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:CancelRetrieval', cancelRetrieval_gatewayARN - Undocumented member.
$sel:tapeARN:CancelRetrieval', cancelRetrieval_tapeARN - The Amazon Resource Name (ARN) of the virtual tape you want to cancel
retrieval for.
data CancelRetrievalResponse Source #
CancelRetrievalOutput
See: newCancelRetrievalResponse smart constructor.
Constructors
| CancelRetrievalResponse' (Maybe Text) Int |
Instances
newCancelRetrievalResponse Source #
Create a value of CancelRetrievalResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeARN:CancelRetrieval', cancelRetrievalResponse_tapeARN - The Amazon Resource Name (ARN) of the virtual tape for which retrieval
was canceled.
$sel:httpStatus:CancelRetrievalResponse', cancelRetrievalResponse_httpStatus - The response's http status code.
DescribeVTLDevices (Paginated)
data DescribeVTLDevices Source #
DescribeVTLDevicesInput
See: newDescribeVTLDevices smart constructor.
Instances
newDescribeVTLDevices Source #
Arguments
| :: Text | |
| -> DescribeVTLDevices |
Create a value of DescribeVTLDevices with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeVTLDevices', describeVTLDevices_marker - An opaque string that indicates the position at which to begin
describing the VTL devices.
$sel:limit:DescribeVTLDevices', describeVTLDevices_limit - Specifies that the number of VTL devices described be limited to the
specified number.
$sel:vTLDeviceARNs:DescribeVTLDevices', describeVTLDevices_vTLDeviceARNs - An array of strings, where each string represents the Amazon Resource
Name (ARN) of a VTL device.
All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
$sel:gatewayARN:DescribeVTLDevices', describeVTLDevices_gatewayARN - Undocumented member.
data DescribeVTLDevicesResponse Source #
DescribeVTLDevicesOutput
See: newDescribeVTLDevicesResponse smart constructor.
Instances
newDescribeVTLDevicesResponse Source #
Create a value of DescribeVTLDevicesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vTLDevices:DescribeVTLDevicesResponse', describeVTLDevicesResponse_vTLDevices - An array of VTL device objects composed of the Amazon Resource Name
(ARN) of the VTL devices.
$sel:gatewayARN:DescribeVTLDevices', describeVTLDevicesResponse_gatewayARN - Undocumented member.
$sel:marker:DescribeVTLDevices', describeVTLDevicesResponse_marker - An opaque string that indicates the position at which the VTL devices
that were fetched for description ended. Use the marker in your next
request to fetch the next set of VTL devices in the list. If there are
no more VTL devices to describe, this field does not appear in the
response.
$sel:httpStatus:DescribeVTLDevicesResponse', describeVTLDevicesResponse_httpStatus - The response's http status code.
StartAvailabilityMonitorTest
data StartAvailabilityMonitorTest Source #
See: newStartAvailabilityMonitorTest smart constructor.
Constructors
| StartAvailabilityMonitorTest' Text |
Instances
newStartAvailabilityMonitorTest Source #
Create a value of StartAvailabilityMonitorTest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:StartAvailabilityMonitorTest', startAvailabilityMonitorTest_gatewayARN - Undocumented member.
data StartAvailabilityMonitorTestResponse Source #
See: newStartAvailabilityMonitorTestResponse smart constructor.
Constructors
| StartAvailabilityMonitorTestResponse' (Maybe Text) Int |
Instances
newStartAvailabilityMonitorTestResponse Source #
Arguments
| :: Int | |
| -> StartAvailabilityMonitorTestResponse |
Create a value of StartAvailabilityMonitorTestResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:StartAvailabilityMonitorTest', startAvailabilityMonitorTestResponse_gatewayARN - Undocumented member.
$sel:httpStatus:StartAvailabilityMonitorTestResponse', startAvailabilityMonitorTestResponse_httpStatus - The response's http status code.
DeleteTapeArchive
data DeleteTapeArchive Source #
DeleteTapeArchiveInput
See: newDeleteTapeArchive smart constructor.
Constructors
| DeleteTapeArchive' (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> DeleteTapeArchive |
Create a value of DeleteTapeArchive with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bypassGovernanceRetention:DeleteTapeArchive', deleteTapeArchive_bypassGovernanceRetention - Set to TRUE to delete an archived tape that belongs to a custom pool
with tape retention lock. Only archived tapes with tape retention lock
set to governance can be deleted. Archived tapes with tape retention
lock set to compliance can't be deleted.
$sel:tapeARN:DeleteTapeArchive', deleteTapeArchive_tapeARN - The Amazon Resource Name (ARN) of the virtual tape to delete from the
virtual tape shelf (VTS).
data DeleteTapeArchiveResponse Source #
DeleteTapeArchiveOutput
See: newDeleteTapeArchiveResponse smart constructor.
Constructors
| DeleteTapeArchiveResponse' (Maybe Text) Int |
Instances
newDeleteTapeArchiveResponse Source #
Create a value of DeleteTapeArchiveResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeARN:DeleteTapeArchive', deleteTapeArchiveResponse_tapeARN - The Amazon Resource Name (ARN) of the virtual tape that was deleted from
the virtual tape shelf (VTS).
$sel:httpStatus:DeleteTapeArchiveResponse', deleteTapeArchiveResponse_httpStatus - The response's http status code.
ListFileSystemAssociations (Paginated)
data ListFileSystemAssociations Source #
See: newListFileSystemAssociations smart constructor.
Instances
newListFileSystemAssociations :: ListFileSystemAssociations Source #
Create a value of ListFileSystemAssociations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ListFileSystemAssociations', listFileSystemAssociations_gatewayARN - Undocumented member.
$sel:marker:ListFileSystemAssociations', listFileSystemAssociations_marker - Opaque pagination token returned from a previous
ListFileSystemAssociations operation. If present, Marker specifies
where to continue the list from after a previous call to
ListFileSystemAssociations. Optional.
$sel:limit:ListFileSystemAssociations', listFileSystemAssociations_limit - The maximum number of file system associations to return in the
response. If present, Limit must be an integer with a value greater
than zero. Optional.
data ListFileSystemAssociationsResponse Source #
See: newListFileSystemAssociationsResponse smart constructor.
Constructors
| ListFileSystemAssociationsResponse' (Maybe [FileSystemAssociationSummary]) (Maybe Text) (Maybe Text) Int |
Instances
newListFileSystemAssociationsResponse Source #
Arguments
| :: Int | |
| -> ListFileSystemAssociationsResponse |
Create a value of ListFileSystemAssociationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystemAssociationSummaryList:ListFileSystemAssociationsResponse', listFileSystemAssociationsResponse_fileSystemAssociationSummaryList - An array of information about the Amazon FSx gateway's file system
associations.
$sel:marker:ListFileSystemAssociations', listFileSystemAssociationsResponse_marker - If the request includes Marker, the response returns that value in
this field.
$sel:nextMarker:ListFileSystemAssociationsResponse', listFileSystemAssociationsResponse_nextMarker - If a value is present, there are more file system associations to
return. In a subsequent request, use NextMarker as the value for
Marker to retrieve the next set of file system associations.
$sel:httpStatus:ListFileSystemAssociationsResponse', listFileSystemAssociationsResponse_httpStatus - The response's http status code.
UpdateSMBFileShare
data UpdateSMBFileShare Source #
UpdateSMBFileShareInput
See: newUpdateSMBFileShare smart constructor.
Constructors
| UpdateSMBFileShare' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe CaseSensitivity) Text |
Instances
newUpdateSMBFileShare Source #
Arguments
| :: Text | |
| -> UpdateSMBFileShare |
Create a value of UpdateSMBFileShare with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessBasedEnumeration:UpdateSMBFileShare', updateSMBFileShare_accessBasedEnumeration - The files and folders on this share will only be visible to users with
read access.
$sel:adminUserList:UpdateSMBFileShare', updateSMBFileShare_adminUserList - A list of users or groups in the Active Directory that have
administrator rights to the file share. A group must be prefixed with
the @ character. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is
set to ActiveDirectory.
$sel:auditDestinationARN:UpdateSMBFileShare', updateSMBFileShare_auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for audit logs.
$sel:invalidUserList:UpdateSMBFileShare', updateSMBFileShare_invalidUserList - A list of users or groups in the Active Directory that are not allowed
to access the file share. A group must be prefixed with the @
character. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is
set to ActiveDirectory.
$sel:kmsKey:UpdateSMBFileShare', updateSMBFileShare_kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
used for Amazon S3 server-side encryption. Storage Gateway does not
support asymmetric CMKs. This value can only be set when KMSEncrypted
is true. Optional.
$sel:validUserList:UpdateSMBFileShare', updateSMBFileShare_validUserList - A list of users or groups in the Active Directory that are allowed to
access the file share. A group must be prefixed with the @ character.
Acceptable formats include: DOMAIN\User1, user1, @group1, and
@DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
$sel:cacheAttributes:UpdateSMBFileShare', updateSMBFileShare_cacheAttributes - Specifies refresh cache information for the file share.
$sel:objectACL:UpdateSMBFileShare', updateSMBFileShare_objectACL - A value that sets the access control list (ACL) permission for objects
in the S3 bucket that a S3 File Gateway puts objects into. The default
value is private.
$sel:kmsEncrypted:UpdateSMBFileShare', updateSMBFileShare_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
$sel:defaultStorageClass:UpdateSMBFileShare', updateSMBFileShare_defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by
the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING.
Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |
S3_STANDARD_IA | S3_ONEZONE_IA
$sel:fileShareName:UpdateSMBFileShare', updateSMBFileShare_fileShareName - The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in
LocationARN.
$sel:sMBACLEnabled:UpdateSMBFileShare', updateSMBFileShare_sMBACLEnabled - Set this value to true to enable access control list (ACL) on the SMB
file share. Set it to false to map file and directory permissions to
the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
Valid Values: true | false
$sel:oplocksEnabled:UpdateSMBFileShare', updateSMBFileShare_oplocksEnabled - Specifies whether opportunistic locking is enabled for the SMB file
share.
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
$sel:notificationPolicy:UpdateSMBFileShare', updateSMBFileShare_notificationPolicy - The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a
client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's
best to set this parameter for as long as possible to avoid generating
multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object
uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with
SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}The following example sets NotificationPolicy off.
{}$sel:requesterPays:UpdateSMBFileShare', updateSMBFileShare_requesterPays - A value that sets who pays the cost of the request and the cost
associated with data download from the S3 bucket. If this value is set
to true, the requester pays the costs; otherwise, the S3 bucket owner
pays. However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file
share, so make sure that the configuration on the file share is the same
as the S3 bucket configuration.
Valid Values: true | false
$sel:guessMIMETypeEnabled:UpdateSMBFileShare', updateSMBFileShare_guessMIMETypeEnabled - A value that enables guessing of the MIME type for uploaded objects
based on file extensions. Set this value to true to enable MIME type
guessing, otherwise set to false. The default value is true.
Valid Values: true | false
$sel:readOnly:UpdateSMBFileShare', updateSMBFileShare_readOnly - A value that sets the write status of a file share. Set this value to
true to set write status to read-only, otherwise set to false.
Valid Values: true | false
$sel:caseSensitivity:UpdateSMBFileShare', updateSMBFileShare_caseSensitivity - The case of an object name in an Amazon S3 bucket. For
ClientSpecified, the client determines the case sensitivity. For
CaseSensitive, the gateway determines the case sensitivity. The
default value is ClientSpecified.
$sel:fileShareARN:UpdateSMBFileShare', updateSMBFileShare_fileShareARN - The Amazon Resource Name (ARN) of the SMB file share that you want to
update.
data UpdateSMBFileShareResponse Source #
UpdateSMBFileShareOutput
See: newUpdateSMBFileShareResponse smart constructor.
Constructors
| UpdateSMBFileShareResponse' (Maybe Text) Int |
Instances
newUpdateSMBFileShareResponse Source #
Create a value of UpdateSMBFileShareResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareARN:UpdateSMBFileShare', updateSMBFileShareResponse_fileShareARN - The Amazon Resource Name (ARN) of the updated SMB file share.
$sel:httpStatus:UpdateSMBFileShareResponse', updateSMBFileShareResponse_httpStatus - The response's http status code.
DescribeNFSFileShares
data DescribeNFSFileShares Source #
DescribeNFSFileSharesInput
See: newDescribeNFSFileShares smart constructor.
Constructors
| DescribeNFSFileShares' (NonEmpty Text) |
Instances
newDescribeNFSFileShares Source #
Create a value of DescribeNFSFileShares with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareARNList:DescribeNFSFileShares', describeNFSFileShares_fileShareARNList - An array containing the Amazon Resource Name (ARN) of each file share to
be described.
data DescribeNFSFileSharesResponse Source #
DescribeNFSFileSharesOutput
See: newDescribeNFSFileSharesResponse smart constructor.
Constructors
| DescribeNFSFileSharesResponse' (Maybe [NFSFileShareInfo]) Int |
Instances
newDescribeNFSFileSharesResponse Source #
Create a value of DescribeNFSFileSharesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nFSFileShareInfoList:DescribeNFSFileSharesResponse', describeNFSFileSharesResponse_nFSFileShareInfoList - An array containing a description for each requested file share.
$sel:httpStatus:DescribeNFSFileSharesResponse', describeNFSFileSharesResponse_httpStatus - The response's http status code.
ListVolumeRecoveryPoints
data ListVolumeRecoveryPoints Source #
See: newListVolumeRecoveryPoints smart constructor.
Constructors
| ListVolumeRecoveryPoints' Text |
Instances
newListVolumeRecoveryPoints Source #
Create a value of ListVolumeRecoveryPoints with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ListVolumeRecoveryPoints', listVolumeRecoveryPoints_gatewayARN - Undocumented member.
data ListVolumeRecoveryPointsResponse Source #
See: newListVolumeRecoveryPointsResponse smart constructor.
Constructors
| ListVolumeRecoveryPointsResponse' (Maybe [VolumeRecoveryPointInfo]) (Maybe Text) Int |
Instances
newListVolumeRecoveryPointsResponse Source #
Create a value of ListVolumeRecoveryPointsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeRecoveryPointInfos:ListVolumeRecoveryPointsResponse', listVolumeRecoveryPointsResponse_volumeRecoveryPointInfos - An array of VolumeRecoveryPointInfo objects.
$sel:gatewayARN:ListVolumeRecoveryPoints', listVolumeRecoveryPointsResponse_gatewayARN - Undocumented member.
$sel:httpStatus:ListVolumeRecoveryPointsResponse', listVolumeRecoveryPointsResponse_httpStatus - The response's http status code.
ListTapes (Paginated)
A JSON object that contains one or more of the following fields:
- ListTapesInput$Limit
- ListTapesInput$Marker
- ListTapesInput$TapeARNs
See: newListTapes smart constructor.
Instances
newListTapes :: ListTapes Source #
Create a value of ListTapes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListTapes', listTapes_marker - A string that indicates the position at which to begin the returned list
of tapes.
$sel:limit:ListTapes', listTapes_limit - An optional number limit for the tapes in the list returned by this
call.
$sel:tapeARNs:ListTapes', listTapes_tapeARNs - Undocumented member.
data ListTapesResponse Source #
A JSON object containing the following fields:
- ListTapesOutput$Marker
- ListTapesOutput$VolumeInfos
See: newListTapesResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> ListTapesResponse |
Create a value of ListTapesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListTapes', listTapesResponse_marker - A string that indicates the position at which to begin returning the
next list of tapes. Use the marker in your next request to continue
pagination of tapes. If there are no more tapes to list, this element
does not appear in the response body.
$sel:tapeInfos:ListTapesResponse', listTapesResponse_tapeInfos - Undocumented member.
$sel:httpStatus:ListTapesResponse', listTapesResponse_httpStatus - The response's http status code.
ResetCache
data ResetCache Source #
See: newResetCache smart constructor.
Constructors
| ResetCache' Text |
Instances
Arguments
| :: Text | |
| -> ResetCache |
Create a value of ResetCache with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ResetCache', resetCache_gatewayARN - Undocumented member.
data ResetCacheResponse Source #
See: newResetCacheResponse smart constructor.
Constructors
| ResetCacheResponse' (Maybe Text) Int |
Instances
newResetCacheResponse Source #
Arguments
| :: Int | |
| -> ResetCacheResponse |
Create a value of ResetCacheResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ResetCache', resetCacheResponse_gatewayARN - Undocumented member.
$sel:httpStatus:ResetCacheResponse', resetCacheResponse_httpStatus - The response's http status code.
DescribeSMBFileShares
data DescribeSMBFileShares Source #
DescribeSMBFileSharesInput
See: newDescribeSMBFileShares smart constructor.
Constructors
| DescribeSMBFileShares' (NonEmpty Text) |
Instances
newDescribeSMBFileShares Source #
Create a value of DescribeSMBFileShares with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareARNList:DescribeSMBFileShares', describeSMBFileShares_fileShareARNList - An array containing the Amazon Resource Name (ARN) of each file share to
be described.
data DescribeSMBFileSharesResponse Source #
DescribeSMBFileSharesOutput
See: newDescribeSMBFileSharesResponse smart constructor.
Constructors
| DescribeSMBFileSharesResponse' (Maybe [SMBFileShareInfo]) Int |
Instances
newDescribeSMBFileSharesResponse Source #
Create a value of DescribeSMBFileSharesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sMBFileShareInfoList:DescribeSMBFileSharesResponse', describeSMBFileSharesResponse_sMBFileShareInfoList - An array containing a description for each requested file share.
$sel:httpStatus:DescribeSMBFileSharesResponse', describeSMBFileSharesResponse_httpStatus - The response's http status code.
ListGateways (Paginated)
data ListGateways Source #
A JSON object containing zero or more of the following fields:
- ListGatewaysInput$Limit
- ListGatewaysInput$Marker
See: newListGateways smart constructor.
Constructors
| ListGateways' (Maybe Text) (Maybe Natural) |
Instances
newListGateways :: ListGateways Source #
Create a value of ListGateways with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListGateways', listGateways_marker - An opaque string that indicates the position at which to begin the
returned list of gateways.
$sel:limit:ListGateways', listGateways_limit - Specifies that the list of gateways returned be limited to the specified
number of items.
data ListGatewaysResponse Source #
See: newListGatewaysResponse smart constructor.
Constructors
| ListGatewaysResponse' (Maybe Text) (Maybe [GatewayInfo]) Int |
Instances
newListGatewaysResponse Source #
Arguments
| :: Int | |
| -> ListGatewaysResponse |
Create a value of ListGatewaysResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListGateways', listGatewaysResponse_marker - Use the marker in your next request to fetch the next set of gateways in
the list. If there are no more gateways to list, this field does not
appear in the response.
$sel:gateways:ListGatewaysResponse', listGatewaysResponse_gateways - An array of GatewayInfo objects.
$sel:httpStatus:ListGatewaysResponse', listGatewaysResponse_httpStatus - The response's http status code.
DeleteTape
data DeleteTape Source #
DeleteTapeInput
See: newDeleteTape smart constructor.
Constructors
| DeleteTape' (Maybe Bool) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteTape |
Create a value of DeleteTape with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bypassGovernanceRetention:DeleteTape', deleteTape_bypassGovernanceRetention - Set to TRUE to delete an archived tape that belongs to a custom pool
with tape retention lock. Only archived tapes with tape retention lock
set to governance can be deleted. Archived tapes with tape retention
lock set to compliance can't be deleted.
$sel:gatewayARN:DeleteTape', deleteTape_gatewayARN - The unique Amazon Resource Name (ARN) of the gateway that the virtual
tape to delete is associated with. Use the ListGateways operation to
return a list of gateways for your account and Region.
$sel:tapeARN:DeleteTape', deleteTape_tapeARN - The Amazon Resource Name (ARN) of the virtual tape to delete.
data DeleteTapeResponse Source #
DeleteTapeOutput
See: newDeleteTapeResponse smart constructor.
Constructors
| DeleteTapeResponse' (Maybe Text) Int |
Instances
newDeleteTapeResponse Source #
Arguments
| :: Int | |
| -> DeleteTapeResponse |
Create a value of DeleteTapeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeARN:DeleteTape', deleteTapeResponse_tapeARN - The Amazon Resource Name (ARN) of the deleted virtual tape.
$sel:httpStatus:DeleteTapeResponse', deleteTapeResponse_httpStatus - The response's http status code.
ListLocalDisks
data ListLocalDisks Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
See: newListLocalDisks smart constructor.
Constructors
| ListLocalDisks' Text |
Instances
Arguments
| :: Text | |
| -> ListLocalDisks |
Create a value of ListLocalDisks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ListLocalDisks', listLocalDisks_gatewayARN - Undocumented member.
data ListLocalDisksResponse Source #
See: newListLocalDisksResponse smart constructor.
Instances
newListLocalDisksResponse Source #
Create a value of ListLocalDisksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ListLocalDisks', listLocalDisksResponse_gatewayARN - Undocumented member.
$sel:disks:ListLocalDisksResponse', listLocalDisksResponse_disks - A JSON object containing the following fields:
- ListLocalDisksOutput$Disks
$sel:httpStatus:ListLocalDisksResponse', listLocalDisksResponse_httpStatus - The response's http status code.
ListVolumes (Paginated)
data ListVolumes Source #
A JSON object that contains one or more of the following fields:
- ListVolumesInput$Limit
- ListVolumesInput$Marker
See: newListVolumes smart constructor.
Instances
newListVolumes :: ListVolumes Source #
Create a value of ListVolumes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ListVolumes', listVolumes_gatewayARN - Undocumented member.
$sel:marker:ListVolumes', listVolumes_marker - A string that indicates the position at which to begin the returned list
of volumes. Obtain the marker from the response of a previous List iSCSI
Volumes request.
$sel:limit:ListVolumes', listVolumes_limit - Specifies that the list of volumes returned be limited to the specified
number of items.
data ListVolumesResponse Source #
A JSON object containing the following fields:
- ListVolumesOutput$Marker
- ListVolumesOutput$VolumeInfos
See: newListVolumesResponse smart constructor.
Constructors
| ListVolumesResponse' (Maybe Text) (Maybe Text) (Maybe [VolumeInfo]) Int |
Instances
newListVolumesResponse Source #
Arguments
| :: Int | |
| -> ListVolumesResponse |
Create a value of ListVolumesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ListVolumes', listVolumesResponse_gatewayARN - Undocumented member.
$sel:marker:ListVolumes', listVolumesResponse_marker - Use the marker in your next request to continue pagination of iSCSI
volumes. If there are no more volumes to list, this field does not
appear in the response body.
$sel:volumeInfos:ListVolumesResponse', listVolumesResponse_volumeInfos - An array of VolumeInfo objects, where each object describes an iSCSI
volume. If no volumes are defined for the gateway, then VolumeInfos is
an empty array "[]".
$sel:httpStatus:ListVolumesResponse', listVolumesResponse_httpStatus - The response's http status code.
UpdateBandwidthRateLimit
data UpdateBandwidthRateLimit Source #
A JSON object containing one or more of the following fields:
- UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec
- UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec
See: newUpdateBandwidthRateLimit smart constructor.
Instances
newUpdateBandwidthRateLimit Source #
Create a value of UpdateBandwidthRateLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:averageUploadRateLimitInBitsPerSec:UpdateBandwidthRateLimit', updateBandwidthRateLimit_averageUploadRateLimitInBitsPerSec - The average upload bandwidth rate limit in bits per second.
$sel:averageDownloadRateLimitInBitsPerSec:UpdateBandwidthRateLimit', updateBandwidthRateLimit_averageDownloadRateLimitInBitsPerSec - The average download bandwidth rate limit in bits per second.
$sel:gatewayARN:UpdateBandwidthRateLimit', updateBandwidthRateLimit_gatewayARN - Undocumented member.
data UpdateBandwidthRateLimitResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle information was updated.
See: newUpdateBandwidthRateLimitResponse smart constructor.
Constructors
| UpdateBandwidthRateLimitResponse' (Maybe Text) Int |
Instances
newUpdateBandwidthRateLimitResponse Source #
Create a value of UpdateBandwidthRateLimitResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateBandwidthRateLimit', updateBandwidthRateLimitResponse_gatewayARN - Undocumented member.
$sel:httpStatus:UpdateBandwidthRateLimitResponse', updateBandwidthRateLimitResponse_httpStatus - The response's http status code.
AddWorkingStorage
data AddWorkingStorage Source #
A JSON object containing one or more of the following fields:
- AddWorkingStorageInput$DiskIds
See: newAddWorkingStorage smart constructor.
Constructors
| AddWorkingStorage' Text [Text] |
Instances
Arguments
| :: Text | |
| -> AddWorkingStorage |
Create a value of AddWorkingStorage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:AddWorkingStorage', addWorkingStorage_gatewayARN - Undocumented member.
$sel:diskIds:AddWorkingStorage', addWorkingStorage_diskIds - An array of strings that identify disks that are to be configured as
working storage. Each string has a minimum length of 1 and maximum
length of 300. You can get the disk IDs from the ListLocalDisks API.
data AddWorkingStorageResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway for which working storage was configured.
See: newAddWorkingStorageResponse smart constructor.
Constructors
| AddWorkingStorageResponse' (Maybe Text) Int |
Instances
newAddWorkingStorageResponse Source #
Create a value of AddWorkingStorageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:AddWorkingStorage', addWorkingStorageResponse_gatewayARN - Undocumented member.
$sel:httpStatus:AddWorkingStorageResponse', addWorkingStorageResponse_httpStatus - The response's http status code.
DescribeTapeRecoveryPoints (Paginated)
data DescribeTapeRecoveryPoints Source #
DescribeTapeRecoveryPointsInput
See: newDescribeTapeRecoveryPoints smart constructor.
Instances
newDescribeTapeRecoveryPoints Source #
Create a value of DescribeTapeRecoveryPoints with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:DescribeTapeRecoveryPoints', describeTapeRecoveryPoints_marker - An opaque string that indicates the position at which to begin
describing the virtual tape recovery points.
$sel:limit:DescribeTapeRecoveryPoints', describeTapeRecoveryPoints_limit - Specifies that the number of virtual tape recovery points that are
described be limited to the specified number.
$sel:gatewayARN:DescribeTapeRecoveryPoints', describeTapeRecoveryPoints_gatewayARN - Undocumented member.
data DescribeTapeRecoveryPointsResponse Source #
DescribeTapeRecoveryPointsOutput
See: newDescribeTapeRecoveryPointsResponse smart constructor.
Constructors
| DescribeTapeRecoveryPointsResponse' (Maybe [TapeRecoveryPointInfo]) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeTapeRecoveryPointsResponse Source #
Arguments
| :: Int | |
| -> DescribeTapeRecoveryPointsResponse |
Create a value of DescribeTapeRecoveryPointsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeRecoveryPointInfos:DescribeTapeRecoveryPointsResponse', describeTapeRecoveryPointsResponse_tapeRecoveryPointInfos - An array of TapeRecoveryPointInfos that are available for the specified
gateway.
$sel:gatewayARN:DescribeTapeRecoveryPoints', describeTapeRecoveryPointsResponse_gatewayARN - Undocumented member.
$sel:marker:DescribeTapeRecoveryPoints', describeTapeRecoveryPointsResponse_marker - An opaque string that indicates the position at which the virtual tape
recovery points that were listed for description ended.
Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.
$sel:httpStatus:DescribeTapeRecoveryPointsResponse', describeTapeRecoveryPointsResponse_httpStatus - The response's http status code.
DeleteBandwidthRateLimit
data DeleteBandwidthRateLimit Source #
A JSON object containing the following fields:
- DeleteBandwidthRateLimitInput$BandwidthType
See: newDeleteBandwidthRateLimit smart constructor.
Constructors
| DeleteBandwidthRateLimit' Text Text |
Instances
newDeleteBandwidthRateLimit Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteBandwidthRateLimit |
Create a value of DeleteBandwidthRateLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DeleteBandwidthRateLimit', deleteBandwidthRateLimit_gatewayARN - Undocumented member.
$sel:bandwidthType:DeleteBandwidthRateLimit', deleteBandwidthRateLimit_bandwidthType - One of the BandwidthType values that indicates the gateway bandwidth
rate limit to delete.
Valid Values: UPLOAD | DOWNLOAD | ALL
data DeleteBandwidthRateLimitResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth rate information was deleted.
See: newDeleteBandwidthRateLimitResponse smart constructor.
Constructors
| DeleteBandwidthRateLimitResponse' (Maybe Text) Int |
Instances
newDeleteBandwidthRateLimitResponse Source #
Create a value of DeleteBandwidthRateLimitResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DeleteBandwidthRateLimit', deleteBandwidthRateLimitResponse_gatewayARN - Undocumented member.
$sel:httpStatus:DeleteBandwidthRateLimitResponse', deleteBandwidthRateLimitResponse_httpStatus - The response's http status code.
ActivateGateway
data ActivateGateway Source #
A JSON object containing one or more of the following fields:
- ActivateGatewayInput$ActivationKey
- ActivateGatewayInput$GatewayName
- ActivateGatewayInput$GatewayRegion
- ActivateGatewayInput$GatewayTimezone
- ActivateGatewayInput$GatewayType
- ActivateGatewayInput$MediumChangerType
- ActivateGatewayInput$TapeDriveType
See: newActivateGateway smart constructor.
Constructors
| ActivateGateway' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ActivateGateway |
Create a value of ActivateGateway with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mediumChangerType:ActivateGateway', activateGateway_mediumChangerType - The value that indicates the type of medium changer to use for tape
gateway. This field is optional.
Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402
$sel:tapeDriveType:ActivateGateway', activateGateway_tapeDriveType - The value that indicates the type of tape drive to use for tape gateway.
This field is optional.
Valid Values: IBM-ULT3580-TD5
$sel:gatewayType:ActivateGateway', activateGateway_gatewayType - A value that defines the type of gateway to activate. The type specified
is critical to all later functions of the gateway and cannot be changed
after activation. The default value is CACHED.
Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB|
$sel:tags:ActivateGateway', activateGateway_tags - A list of up to 50 tags that you can assign to the gateway. Each tag is
a key-value pair.
Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
$sel:activationKey:ActivateGateway', activateGateway_activationKey - Your gateway activation key. You can obtain the activation key by
sending an HTTP GET request with redirects enabled to the gateway IP
address (port 80). The redirect URL returned in the response provides
you the activation key for your gateway in the query string parameter
activationKey. It may also include other activation-related
parameters, however, these are merely defaults -- the arguments you pass
to the ActivateGateway API call determine the actual configuration of
your gateway.
For more information, see Getting activation key in the Storage Gateway User Guide.
$sel:gatewayName:ActivateGateway', activateGateway_gatewayName - The name you configured for your gateway.
$sel:gatewayTimezone:ActivateGateway', activateGateway_gatewayTimezone - A value that indicates the time zone you want to set for the gateway.
The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For
example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00
indicates the time is 2 hours ahead of GMT. The time zone is used, for
example, for scheduling snapshots and your gateway's maintenance
schedule.
$sel:gatewayRegion:ActivateGateway', activateGateway_gatewayRegion - A value that indicates the Region where you want to store your data. The
gateway Region specified must be the same Region as the Region in your
Host header in the request. For more information about available
Regions and endpoints for Storage Gateway, see
Storage Gateway endpoints and quotas
in the Amazon Web Services General Reference.
Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
data ActivateGatewayResponse Source #
Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and Region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.
For gateways activated prior to September 02, 2015, the gateway ARN contains the gateway name rather than the gateway ID. Changing the name of the gateway has no effect on the gateway ARN.
See: newActivateGatewayResponse smart constructor.
Constructors
| ActivateGatewayResponse' (Maybe Text) Int |
Instances
newActivateGatewayResponse Source #
Create a value of ActivateGatewayResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ActivateGatewayResponse', activateGatewayResponse_gatewayARN - Undocumented member.
$sel:httpStatus:ActivateGatewayResponse', activateGatewayResponse_httpStatus - The response's http status code.
DescribeCache
data DescribeCache Source #
See: newDescribeCache smart constructor.
Constructors
| DescribeCache' Text |
Instances
Arguments
| :: Text | |
| -> DescribeCache |
Create a value of DescribeCache with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeCache', describeCache_gatewayARN - Undocumented member.
data DescribeCacheResponse Source #
See: newDescribeCacheResponse smart constructor.
Constructors
| DescribeCacheResponse' (Maybe Text) (Maybe [Text]) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Integer) (Maybe Double) Int |
Instances
newDescribeCacheResponse Source #
Create a value of DescribeCacheResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:DescribeCache', describeCacheResponse_gatewayARN - Undocumented member.
$sel:diskIds:DescribeCacheResponse', describeCacheResponse_diskIds - An array of strings that identify disks that are to be configured as
working storage. Each string has a minimum length of 1 and maximum
length of 300. You can get the disk IDs from the ListLocalDisks API.
$sel:cacheUsedPercentage:DescribeCacheResponse', describeCacheResponse_cacheUsedPercentage - Percent use of the gateway's cache storage. This metric applies only to
the gateway-cached volume setup. The sample is taken at the end of the
reporting period.
$sel:cacheHitPercentage:DescribeCacheResponse', describeCacheResponse_cacheHitPercentage - Percent of application read operations from the file shares that are
served from cache. The sample is taken at the end of the reporting
period.
$sel:cacheMissPercentage:DescribeCacheResponse', describeCacheResponse_cacheMissPercentage - Percent of application read operations from the file shares that are not
served from cache. The sample is taken at the end of the reporting
period.
$sel:cacheAllocatedInBytes:DescribeCacheResponse', describeCacheResponse_cacheAllocatedInBytes - The amount of cache in bytes allocated to a gateway.
$sel:cacheDirtyPercentage:DescribeCacheResponse', describeCacheResponse_cacheDirtyPercentage - The file share's contribution to the overall percentage of the
gateway's cache that has not been persisted to Amazon Web Services. The
sample is taken at the end of the reporting period.
$sel:httpStatus:DescribeCacheResponse', describeCacheResponse_httpStatus - The response's http status code.
DeleteVolume
data DeleteVolume Source #
A JSON object containing the DeleteVolumeInput$VolumeARN to delete.
See: newDeleteVolume smart constructor.
Constructors
| DeleteVolume' Text |
Instances
Arguments
| :: Text | |
| -> DeleteVolume |
Create a value of DeleteVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeARN:DeleteVolume', deleteVolume_volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
operation to return a list of gateway volumes.
data DeleteVolumeResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted.
See: newDeleteVolumeResponse smart constructor.
Constructors
| DeleteVolumeResponse' (Maybe Text) Int |
Instances
newDeleteVolumeResponse Source #
Arguments
| :: Int | |
| -> DeleteVolumeResponse |
Create a value of DeleteVolumeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeARN:DeleteVolume', deleteVolumeResponse_volumeARN - The Amazon Resource Name (ARN) of the storage volume that was deleted.
It is the same ARN you provided in the request.
$sel:httpStatus:DeleteVolumeResponse', deleteVolumeResponse_httpStatus - The response's http status code.
Types
ActiveDirectoryStatus
newtype ActiveDirectoryStatus Source #
Constructors
| ActiveDirectoryStatus' | |
Fields | |
Bundled Patterns
Instances
AvailabilityMonitorTestStatus
newtype AvailabilityMonitorTestStatus Source #
Constructors
| AvailabilityMonitorTestStatus' | |
Fields | |
Bundled Patterns
Instances
CaseSensitivity
newtype CaseSensitivity Source #
Constructors
| CaseSensitivity' | |
Fields | |
Bundled Patterns
| pattern CaseSensitivity_CaseSensitive :: CaseSensitivity | |
| pattern CaseSensitivity_ClientSpecified :: CaseSensitivity |
Instances
FileShareType
newtype FileShareType Source #
The type of the file share.
Constructors
| FileShareType' | |
Fields | |
Bundled Patterns
| pattern FileShareType_NFS :: FileShareType | |
| pattern FileShareType_SMB :: FileShareType |
Instances
GatewayCapacity
newtype GatewayCapacity Source #
Constructors
| GatewayCapacity' | |
Fields | |
Bundled Patterns
| pattern GatewayCapacity_Large :: GatewayCapacity | |
| pattern GatewayCapacity_Medium :: GatewayCapacity | |
| pattern GatewayCapacity_Small :: GatewayCapacity |
Instances
HostEnvironment
newtype HostEnvironment Source #
Constructors
| HostEnvironment' | |
Fields | |
Bundled Patterns
| pattern HostEnvironment_EC2 :: HostEnvironment | |
| pattern HostEnvironment_HYPER_V :: HostEnvironment | |
| pattern HostEnvironment_KVM :: HostEnvironment | |
| pattern HostEnvironment_OTHER :: HostEnvironment | |
| pattern HostEnvironment_VMWARE :: HostEnvironment |
Instances
ObjectACL
A value that sets the access control list (ACL) permission for objects
in the S3 bucket that an S3 File Gateway puts objects into. The default
value is private.
Constructors
| ObjectACL' | |
Fields | |
Bundled Patterns
| pattern ObjectACL_Authenticated_read :: ObjectACL | |
| pattern ObjectACL_Aws_exec_read :: ObjectACL | |
| pattern ObjectACL_Bucket_owner_full_control :: ObjectACL | |
| pattern ObjectACL_Bucket_owner_read :: ObjectACL | |
| pattern ObjectACL_Private :: ObjectACL | |
| pattern ObjectACL_Public_read :: ObjectACL | |
| pattern ObjectACL_Public_read_write :: ObjectACL |
Instances
PoolStatus
newtype PoolStatus Source #
Constructors
| PoolStatus' | |
Fields | |
Bundled Patterns
| pattern PoolStatus_ACTIVE :: PoolStatus | |
| pattern PoolStatus_DELETED :: PoolStatus |
Instances
RetentionLockType
newtype RetentionLockType Source #
Constructors
| RetentionLockType' | |
Fields | |
Bundled Patterns
| pattern RetentionLockType_COMPLIANCE :: RetentionLockType | |
| pattern RetentionLockType_GOVERNANCE :: RetentionLockType | |
| pattern RetentionLockType_NONE :: RetentionLockType |
Instances
SMBSecurityStrategy
newtype SMBSecurityStrategy Source #
Constructors
| SMBSecurityStrategy' | |
Fields | |
Bundled Patterns
Instances
TapeStorageClass
newtype TapeStorageClass Source #
Constructors
| TapeStorageClass' | |
Fields | |
Bundled Patterns
| pattern TapeStorageClass_DEEP_ARCHIVE :: TapeStorageClass | |
| pattern TapeStorageClass_GLACIER :: TapeStorageClass |
Instances
AutomaticTapeCreationPolicyInfo
data AutomaticTapeCreationPolicyInfo Source #
Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.
See: newAutomaticTapeCreationPolicyInfo smart constructor.
Constructors
| AutomaticTapeCreationPolicyInfo' (Maybe Text) (Maybe (NonEmpty AutomaticTapeCreationRule)) |
Instances
newAutomaticTapeCreationPolicyInfo :: AutomaticTapeCreationPolicyInfo Source #
Create a value of AutomaticTapeCreationPolicyInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:AutomaticTapeCreationPolicyInfo', automaticTapeCreationPolicyInfo_gatewayARN - Undocumented member.
$sel:automaticTapeCreationRules:AutomaticTapeCreationPolicyInfo', automaticTapeCreationPolicyInfo_automaticTapeCreationRules - An automatic tape creation policy consists of a list of automatic tape
creation rules. This returns the rules that determine when and how to
automatically create new tapes.
AutomaticTapeCreationRule
data AutomaticTapeCreationRule Source #
An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically.
See: newAutomaticTapeCreationRule smart constructor.
Instances
newAutomaticTapeCreationRule Source #
Arguments
| :: Text | |
| -> Text | |
| -> Integer | |
| -> Natural | |
| -> AutomaticTapeCreationRule |
Create a value of AutomaticTapeCreationRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:worm:AutomaticTapeCreationRule', automaticTapeCreationRule_worm - Set to true to indicate that tapes are to be archived as
write-once-read-many (WORM). Set to false when WORM is not enabled for
tapes.
$sel:tapeBarcodePrefix:AutomaticTapeCreationRule', automaticTapeCreationRule_tapeBarcodePrefix - A prefix that you append to the barcode of the virtual tape that you are
creating. This prefix makes the barcode unique.
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
$sel:poolId:AutomaticTapeCreationRule', automaticTapeCreationRule_poolId - The ID of the pool that you want to add your tape to for archiving. The
tape in this pool is archived in the Amazon S3 storage class that is
associated with the pool. When you use your backup application to eject
the tape, the tape is archived directly into the storage class (S3
Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
$sel:tapeSizeInBytes:AutomaticTapeCreationRule', automaticTapeCreationRule_tapeSizeInBytes - The size, in bytes, of the virtual tape capacity.
$sel:minimumNumTapes:AutomaticTapeCreationRule', automaticTapeCreationRule_minimumNumTapes - The minimum number of available virtual tapes that the gateway maintains
at all times. If the number of tapes on the gateway goes below this
value, the gateway creates as many new tapes as are needed to have
MinimumNumTapes on the gateway. For more information about automatic
tape creation, see
Creating Tapes Automatically.
BandwidthRateLimitInterval
data BandwidthRateLimitInterval Source #
Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
See: newBandwidthRateLimitInterval smart constructor.
Constructors
| BandwidthRateLimitInterval' (Maybe Natural) (Maybe Natural) Natural Natural Natural Natural (NonEmpty Natural) |
Instances
newBandwidthRateLimitInterval Source #
Create a value of BandwidthRateLimitInterval with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:averageUploadRateLimitInBitsPerSec:BandwidthRateLimitInterval', bandwidthRateLimitInterval_averageUploadRateLimitInBitsPerSec - The average upload rate limit component of the bandwidth rate limit
interval, in bits per second. This field does not appear in the response
if the upload rate limit is not set.
$sel:averageDownloadRateLimitInBitsPerSec:BandwidthRateLimitInterval', bandwidthRateLimitInterval_averageDownloadRateLimitInBitsPerSec - The average download rate limit component of the bandwidth rate limit
interval, in bits per second. This field does not appear in the response
if the download rate limit is not set.
$sel:startHourOfDay:BandwidthRateLimitInterval', bandwidthRateLimitInterval_startHourOfDay - The hour of the day to start the bandwidth rate limit interval.
$sel:startMinuteOfHour:BandwidthRateLimitInterval', bandwidthRateLimitInterval_startMinuteOfHour - The minute of the hour to start the bandwidth rate limit interval. The
interval begins at the start of that minute. To begin an interval
exactly at the start of the hour, use the value 0.
$sel:endHourOfDay:BandwidthRateLimitInterval', bandwidthRateLimitInterval_endHourOfDay - The hour of the day to end the bandwidth rate limit interval.
$sel:endMinuteOfHour:BandwidthRateLimitInterval', bandwidthRateLimitInterval_endMinuteOfHour - The minute of the hour to end the bandwidth rate limit interval.
The bandwidth rate limit interval ends at the end of the minute. To end
an interval at the end of an hour, use the value 59.
$sel:daysOfWeek:BandwidthRateLimitInterval', bandwidthRateLimitInterval_daysOfWeek - The days of the week component of the bandwidth rate limit interval,
represented as ordinal numbers from 0 to 6, where 0 represents Sunday
and 6 represents Saturday.
CacheAttributes
data CacheAttributes Source #
The refresh cache information for the file share or FSx file systems.
See: newCacheAttributes smart constructor.
Constructors
| CacheAttributes' (Maybe Int) |
Instances
newCacheAttributes :: CacheAttributes Source #
Create a value of CacheAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cacheStaleTimeoutInSeconds:CacheAttributes', cacheAttributes_cacheStaleTimeoutInSeconds - Refreshes a file share's cache by using Time To Live (TTL). TTL is the
length of time since the last refresh after which access to the
directory would cause the file gateway to first refresh that
directory's contents from the Amazon S3 bucket or Amazon FSx file
system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
CachediSCSIVolume
data CachediSCSIVolume Source #
Describes an iSCSI cached volume.
See: newCachediSCSIVolume smart constructor.
Constructors
| CachediSCSIVolume' (Maybe VolumeiSCSIAttributes) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Integer) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newCachediSCSIVolume :: CachediSCSIVolume Source #
Create a value of CachediSCSIVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeiSCSIAttributes:CachediSCSIVolume', cachediSCSIVolume_volumeiSCSIAttributes - An VolumeiSCSIAttributes object that represents a collection of iSCSI
attributes for one stored volume.
$sel:volumeStatus:CachediSCSIVolume', cachediSCSIVolume_volumeStatus - One of the VolumeStatus values that indicates the state of the storage
volume.
$sel:sourceSnapshotId:CachediSCSIVolume', cachediSCSIVolume_sourceSnapshotId - If the cached volume was created from a snapshot, this field contains
the snapshot ID used, e.g., snap-78e22663. Otherwise, this field is not
included.
$sel:kmsKey:CachediSCSIVolume', cachediSCSIVolume_kmsKey - Undocumented member.
$sel:volumeAttachmentStatus:CachediSCSIVolume', cachediSCSIVolume_volumeAttachmentStatus - A value that indicates whether a storage volume is attached to or
detached from a gateway. For more information, see
Moving your volumes to a different gateway.
$sel:volumeARN:CachediSCSIVolume', cachediSCSIVolume_volumeARN - The Amazon Resource Name (ARN) of the storage volume.
$sel:volumeProgress:CachediSCSIVolume', cachediSCSIVolume_volumeProgress - Represents the percentage complete if the volume is restoring or
bootstrapping that represents the percent of data transferred. This
field does not appear in the response if the cached volume is not
restoring or bootstrapping.
$sel:volumeSizeInBytes:CachediSCSIVolume', cachediSCSIVolume_volumeSizeInBytes - The size, in bytes, of the volume capacity.
$sel:volumeUsedInBytes:CachediSCSIVolume', cachediSCSIVolume_volumeUsedInBytes - The size of the data stored on the volume in bytes. This value is
calculated based on the number of blocks that are touched, instead of
the actual amount of data written. This value can be useful for
sequential write patterns but less accurate for random write patterns.
VolumeUsedInBytes is different from the compressed size of the volume,
which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
$sel:createdDate:CachediSCSIVolume', cachediSCSIVolume_createdDate - The date the volume was created. Volumes created prior to March 28, 2017
don’t have this timestamp.
$sel:volumeId:CachediSCSIVolume', cachediSCSIVolume_volumeId - The unique identifier of the volume, e.g., vol-AE4B946D.
$sel:volumeType:CachediSCSIVolume', cachediSCSIVolume_volumeType - One of the VolumeType enumeration values that describes the type of the
volume.
$sel:targetName:CachediSCSIVolume', cachediSCSIVolume_targetName - The name of the iSCSI target used by an initiator to connect to a volume
and used as a suffix for the target ARN. For example, specifying
TargetName as myvolume results in the target ARN of
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.
The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
ChapInfo
Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
See: newChapInfo smart constructor.
Instances
newChapInfo :: ChapInfo Source #
Create a value of ChapInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetARN:ChapInfo', chapInfo_targetARN - The Amazon Resource Name (ARN) of the volume.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
$sel:secretToAuthenticateInitiator:ChapInfo', chapInfo_secretToAuthenticateInitiator - The secret key that the initiator (for example, the Windows client) must
provide to participate in mutual CHAP with the target.
$sel:initiatorName:ChapInfo', chapInfo_initiatorName - The iSCSI initiator that connects to the target.
$sel:secretToAuthenticateTarget:ChapInfo', chapInfo_secretToAuthenticateTarget - The secret key that the target must provide to participate in mutual
CHAP with the initiator (e.g., Windows client).
DeviceiSCSIAttributes
data DeviceiSCSIAttributes Source #
Lists iSCSI information about a VTL device.
See: newDeviceiSCSIAttributes smart constructor.
Instances
newDeviceiSCSIAttributes :: DeviceiSCSIAttributes Source #
Create a value of DeviceiSCSIAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetARN:DeviceiSCSIAttributes', deviceiSCSIAttributes_targetARN - Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI
qualified name(iqn) of a tape drive or media changer target.
$sel:chapEnabled:DeviceiSCSIAttributes', deviceiSCSIAttributes_chapEnabled - Indicates whether mutual CHAP is enabled for the iSCSI target.
$sel:networkInterfaceId:DeviceiSCSIAttributes', deviceiSCSIAttributes_networkInterfaceId - The network interface identifier of the VTL device.
$sel:networkInterfacePort:DeviceiSCSIAttributes', deviceiSCSIAttributes_networkInterfacePort - The port used to communicate with iSCSI VTL device targets.
Disk
Represents a gateway's local disk.
See: newDisk smart constructor.
Constructors
| Disk' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe [Text]) |
Instances
Create a value of Disk with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:diskAllocationResource:Disk', disk_diskAllocationResource - The iSCSI qualified name (IQN) that is defined for a disk. This field is
not included in the response if the local disk is not defined as an
iSCSI target. The format of this field is
targetIqn::LUNNumber::region-volumeId.
$sel:diskAllocationType:Disk', disk_diskAllocationType - Undocumented member.
$sel:diskNode:Disk', disk_diskNode - The device node of a local disk as assigned by the virtualization
environment.
$sel:diskPath:Disk', disk_diskPath - The path of a local disk in the gateway virtual machine (VM).
$sel:diskSizeInBytes:Disk', disk_diskSizeInBytes - The local disk size in bytes.
$sel:diskStatus:Disk', disk_diskStatus - A value that represents the status of a local disk.
$sel:diskId:Disk', disk_diskId - The unique device ID or other distinguishing data that identifies a
local disk.
$sel:diskAttributeList:Disk', disk_diskAttributeList - Undocumented member.
EndpointNetworkConfiguration
data EndpointNetworkConfiguration Source #
Specifies network configuration information for the gateway associated with the Amazon FSx file system.
See: newEndpointNetworkConfiguration smart constructor.
Constructors
| EndpointNetworkConfiguration' (Maybe [Text]) |
Instances
newEndpointNetworkConfiguration :: EndpointNetworkConfiguration Source #
Create a value of EndpointNetworkConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ipAddresses:EndpointNetworkConfiguration', endpointNetworkConfiguration_ipAddresses - A list of gateway IP addresses on which the associated Amazon FSx file
system is available.
If multiple file systems are associated with this gateway, this field is required.
FileShareInfo
data FileShareInfo Source #
Describes a file share. Only supported S3 File Gateway.
See: newFileShareInfo smart constructor.
Constructors
| FileShareInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe FileShareType) |
Instances
newFileShareInfo :: FileShareInfo Source #
Create a value of FileShareInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareStatus:FileShareInfo', fileShareInfo_fileShareStatus - Undocumented member.
$sel:gatewayARN:FileShareInfo', fileShareInfo_gatewayARN - Undocumented member.
$sel:fileShareId:FileShareInfo', fileShareInfo_fileShareId - Undocumented member.
$sel:fileShareARN:FileShareInfo', fileShareInfo_fileShareARN - Undocumented member.
$sel:fileShareType:FileShareInfo', fileShareInfo_fileShareType - Undocumented member.
FileSystemAssociationInfo
data FileSystemAssociationInfo Source #
Describes the object returned by DescribeFileSystemAssociations that
describes a created file system association.
See: newFileSystemAssociationInfo smart constructor.
Constructors
| FileSystemAssociationInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CacheAttributes) (Maybe EndpointNetworkConfiguration) (Maybe Text) (Maybe Text) (Maybe [Tag]) |
Instances
newFileSystemAssociationInfo :: FileSystemAssociationInfo Source #
Create a value of FileSystemAssociationInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:auditDestinationARN:FileSystemAssociationInfo', fileSystemAssociationInfo_auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for the audit logs.
$sel:fileSystemAssociationARN:FileSystemAssociationInfo', fileSystemAssociationInfo_fileSystemAssociationARN - The Amazon Resource Name (ARN) of the file system association.
$sel:gatewayARN:FileSystemAssociationInfo', fileSystemAssociationInfo_gatewayARN - Undocumented member.
$sel:cacheAttributes:FileSystemAssociationInfo', fileSystemAssociationInfo_cacheAttributes - Undocumented member.
$sel:endpointNetworkConfiguration:FileSystemAssociationInfo', fileSystemAssociationInfo_endpointNetworkConfiguration - Specifies network configuration information for the gateway associated
with the Amazon FSx file system.
If multiple file systems are associated with this gateway, this
parameter's IpAddresses field is required.
$sel:locationARN:FileSystemAssociationInfo', fileSystemAssociationInfo_locationARN - The ARN of the backend Amazon FSx file system used for storing file
data. For information, see
FileSystem
in the Amazon FSx API Reference.
$sel:fileSystemAssociationStatus:FileSystemAssociationInfo', fileSystemAssociationInfo_fileSystemAssociationStatus - The status of the file system association. Valid Values: AVAILABLE |
CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR
$sel:tags:FileSystemAssociationInfo', fileSystemAssociationInfo_tags - A list of up to 50 tags assigned to the SMB file share, sorted
alphabetically by key name. Each tag is a key-value pair.
FileSystemAssociationSummary
data FileSystemAssociationSummary Source #
Gets the summary returned by ListFileSystemAssociation, which is a
summary of a created file system association.
See: newFileSystemAssociationSummary smart constructor.
Instances
newFileSystemAssociationSummary :: FileSystemAssociationSummary Source #
Create a value of FileSystemAssociationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystemAssociationARN:FileSystemAssociationSummary', fileSystemAssociationSummary_fileSystemAssociationARN - The Amazon Resource Name (ARN) of the file system association.
$sel:gatewayARN:FileSystemAssociationSummary', fileSystemAssociationSummary_gatewayARN - Undocumented member.
$sel:fileSystemAssociationId:FileSystemAssociationSummary', fileSystemAssociationSummary_fileSystemAssociationId - The ID of the file system association.
$sel:fileSystemAssociationStatus:FileSystemAssociationSummary', fileSystemAssociationSummary_fileSystemAssociationStatus - The status of the file share. Valid Values: AVAILABLE | CREATING |
DELETING | FORCE_DELETING | UPDATING | ERROR
GatewayInfo
data GatewayInfo Source #
Describes a gateway object.
See: newGatewayInfo smart constructor.
Constructors
| GatewayInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newGatewayInfo :: GatewayInfo Source #
Create a value of GatewayInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ec2InstanceRegion:GatewayInfo', gatewayInfo_ec2InstanceRegion - The Region where the Amazon EC2 instance is located.
$sel:gatewayARN:GatewayInfo', gatewayInfo_gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and Region.
$sel:ec2InstanceId:GatewayInfo', gatewayInfo_ec2InstanceId - The ID of the Amazon EC2 instance that was used to launch the gateway.
$sel:gatewayOperationalState:GatewayInfo', gatewayInfo_gatewayOperationalState - The state of the gateway.
Valid Values: DISABLED | ACTIVE
$sel:gatewayName:GatewayInfo', gatewayInfo_gatewayName - The name of the gateway.
$sel:gatewayId:GatewayInfo', gatewayInfo_gatewayId - The unique identifier assigned to your gateway during activation. This
ID becomes part of the gateway Amazon Resource Name (ARN), which you use
as input for other operations.
$sel:gatewayType:GatewayInfo', gatewayInfo_gatewayType - The type of the gateway.
NFSFileShareDefaults
data NFSFileShareDefaults Source #
Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for S3 File Gateways.
See: newNFSFileShareDefaults smart constructor.
Instances
newNFSFileShareDefaults :: NFSFileShareDefaults Source #
Create a value of NFSFileShareDefaults with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileMode:NFSFileShareDefaults', nFSFileShareDefaults_fileMode - The Unix file mode in the form "nnnn". For example, 0666 represents
the default file mode inside the file share. The default value is
0666.
$sel:ownerId:NFSFileShareDefaults', nFSFileShareDefaults_ownerId - The default owner ID for files in the file share (unless the files have
another owner ID specified). The default value is nfsnobody.
$sel:directoryMode:NFSFileShareDefaults', nFSFileShareDefaults_directoryMode - The Unix directory mode in the form "nnnn". For example, 0666
represents the default access mode for all directories inside the file
share. The default value is 0777.
$sel:groupId:NFSFileShareDefaults', nFSFileShareDefaults_groupId - The default group ID for the file share (unless the files have another
group ID specified). The default value is nfsnobody.
NFSFileShareInfo
data NFSFileShareInfo Source #
The Unix file permissions and ownership information assigned, by default, to native S3 objects when an S3 File Gateway discovers them in S3 buckets. This operation is only supported in S3 File Gateways.
See: newNFSFileShareInfo smart constructor.
Constructors
| NFSFileShareInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NFSFileShareDefaults) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Tag]) |
Instances
newNFSFileShareInfo :: NFSFileShareInfo Source #
Create a value of NFSFileShareInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileShareStatus:NFSFileShareInfo', nFSFileShareInfo_fileShareStatus - Undocumented member.
$sel:kmsKey:NFSFileShareInfo', nFSFileShareInfo_kmsKey - Undocumented member.
$sel:gatewayARN:NFSFileShareInfo', nFSFileShareInfo_gatewayARN - Undocumented member.
$sel:path:NFSFileShareInfo', nFSFileShareInfo_path - Undocumented member.
$sel:vPCEndpointDNSName:NFSFileShareInfo', nFSFileShareInfo_vPCEndpointDNSName - Specifies the DNS name for the VPC endpoint that the NFS file share uses
to connect to Amazon S3.
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
$sel:cacheAttributes:NFSFileShareInfo', nFSFileShareInfo_cacheAttributes - Refresh cache information for the file share.
$sel:objectACL:NFSFileShareInfo', nFSFileShareInfo_objectACL - Undocumented member.
$sel:kmsEncrypted:NFSFileShareInfo', nFSFileShareInfo_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
$sel:fileShareId:NFSFileShareInfo', nFSFileShareInfo_fileShareId - Undocumented member.
$sel:fileShareARN:NFSFileShareInfo', nFSFileShareInfo_fileShareARN - Undocumented member.
$sel:defaultStorageClass:NFSFileShareInfo', nFSFileShareInfo_defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by
the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING.
Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |
S3_STANDARD_IA | S3_ONEZONE_IA
$sel:fileShareName:NFSFileShareInfo', nFSFileShareInfo_fileShareName - The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in
LocationARN.
$sel:role':NFSFileShareInfo', nFSFileShareInfo_role - Undocumented member.
$sel:notificationPolicy:NFSFileShareInfo', nFSFileShareInfo_notificationPolicy - The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a
client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's
best to set this parameter for as long as possible to avoid generating
multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object
uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with
SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}The following example sets NotificationPolicy off.
{}$sel:squash:NFSFileShareInfo', nFSFileShareInfo_squash - Undocumented member.
$sel:requesterPays:NFSFileShareInfo', nFSFileShareInfo_requesterPays - A value that sets who pays the cost of the request and the cost
associated with data download from the S3 bucket. If this value is set
to true, the requester pays the costs; otherwise, the S3 bucket owner
pays. However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file
share, so make sure that the configuration on the file share is the same
as the S3 bucket configuration.
Valid Values: true | false
$sel:nFSFileShareDefaults:NFSFileShareInfo', nFSFileShareInfo_nFSFileShareDefaults - Undocumented member.
$sel:locationARN:NFSFileShareInfo', nFSFileShareInfo_locationARN - Undocumented member.
$sel:clientList:NFSFileShareInfo', nFSFileShareInfo_clientList - Undocumented member.
$sel:guessMIMETypeEnabled:NFSFileShareInfo', nFSFileShareInfo_guessMIMETypeEnabled - A value that enables guessing of the MIME type for uploaded objects
based on file extensions. Set this value to true to enable MIME type
guessing, otherwise set to false. The default value is true.
Valid Values: true | false
$sel:readOnly:NFSFileShareInfo', nFSFileShareInfo_readOnly - A value that sets the write status of a file share. Set this value to
true to set the write status to read-only, otherwise set to false.
Valid Values: true | false
$sel:bucketRegion:NFSFileShareInfo', nFSFileShareInfo_bucketRegion - Specifies the Region of the S3 bucket where the NFS file share stores
files.
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
$sel:tags:NFSFileShareInfo', nFSFileShareInfo_tags - A list of up to 50 tags assigned to the NFS file share, sorted
alphabetically by key name. Each tag is a key-value pair. For a gateway
with more than 10 tags assigned, you can view all tags using the
ListTagsForResource API operation.
NetworkInterface
data NetworkInterface Source #
Describes a gateway's network interface.
See: newNetworkInterface smart constructor.
Instances
newNetworkInterface :: NetworkInterface Source #
Create a value of NetworkInterface with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ipv6Address:NetworkInterface', networkInterface_ipv6Address - The Internet Protocol version 6 (IPv6) address of the interface.
Currently not supported.
$sel:macAddress:NetworkInterface', networkInterface_macAddress - The Media Access Control (MAC) address of the interface.
This is currently unsupported and will not be returned in output.
$sel:ipv4Address:NetworkInterface', networkInterface_ipv4Address - The Internet Protocol version 4 (IPv4) address of the interface.
PoolInfo
Describes a custom tape pool.
See: newPoolInfo smart constructor.
Constructors
| PoolInfo' (Maybe RetentionLockType) (Maybe Natural) (Maybe Text) (Maybe TapeStorageClass) (Maybe PoolStatus) (Maybe Text) |
Instances
newPoolInfo :: PoolInfo Source #
Create a value of PoolInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:retentionLockType:PoolInfo', poolInfo_retentionLockType - Tape retention lock type, which can be configured in two modes. When
configured in governance mode, accounts with specific IAM permissions
are authorized to remove the tape retention lock from archived virtual
tapes. When configured in compliance mode, the tape retention lock
cannot be removed by any user, including the root account.
$sel:retentionLockTimeInDays:PoolInfo', poolInfo_retentionLockTimeInDays - Tape retention lock time is set in days. Tape retention lock can be
enabled for up to 100 years (36,500 days).
$sel:poolName:PoolInfo', poolInfo_poolName - The name of the custom tape pool. PoolName can use all ASCII
characters, except '/' and '\'.
$sel:storageClass:PoolInfo', poolInfo_storageClass - The storage class that is associated with the custom pool. When you use
your backup application to eject the tape, the tape is archived directly
into the storage class (S3 Glacier or S3 Glacier Deep Archive) that
corresponds to the pool.
$sel:poolStatus:PoolInfo', poolInfo_poolStatus - Status of the custom tape pool. Pool can be ACTIVE or DELETED.
$sel:poolARN:PoolInfo', poolInfo_poolARN - The Amazon Resource Name (ARN) of the custom tape pool. Use the
ListTapePools operation to return a list of custom tape pools for your
account and Region.
SMBFileShareInfo
data SMBFileShareInfo Source #
The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 File Gateways.
See: newSMBFileShareInfo smart constructor.
Constructors
| SMBFileShareInfo' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CacheAttributes) (Maybe ObjectACL) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe CaseSensitivity) (Maybe [Tag]) |
Instances
newSMBFileShareInfo :: SMBFileShareInfo Source #
Create a value of SMBFileShareInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessBasedEnumeration:SMBFileShareInfo', sMBFileShareInfo_accessBasedEnumeration - Indicates whether AccessBasedEnumeration is enabled.
$sel:adminUserList:SMBFileShareInfo', sMBFileShareInfo_adminUserList - A list of users or groups in the Active Directory that have
administrator rights to the file share. A group must be prefixed with
the @ character. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is
set to ActiveDirectory.
$sel:auditDestinationARN:SMBFileShareInfo', sMBFileShareInfo_auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for audit logs.
$sel:fileShareStatus:SMBFileShareInfo', sMBFileShareInfo_fileShareStatus - Undocumented member.
$sel:invalidUserList:SMBFileShareInfo', sMBFileShareInfo_invalidUserList - A list of users or groups in the Active Directory that are not allowed
to access the file share. A group must be prefixed with the @
character. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is
set to ActiveDirectory.
$sel:kmsKey:SMBFileShareInfo', sMBFileShareInfo_kmsKey - Undocumented member.
$sel:validUserList:SMBFileShareInfo', sMBFileShareInfo_validUserList - A list of users or groups in the Active Directory that are allowed to
access the file share. A group must be prefixed with the @ character.
Acceptable formats include: DOMAIN\User1, user1, @group1, and
@DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
$sel:gatewayARN:SMBFileShareInfo', sMBFileShareInfo_gatewayARN - Undocumented member.
$sel:path:SMBFileShareInfo', sMBFileShareInfo_path - The file share path used by the SMB client to identify the mount point.
$sel:vPCEndpointDNSName:SMBFileShareInfo', sMBFileShareInfo_vPCEndpointDNSName - Specifies the DNS name for the VPC endpoint that the SMB file share uses
to connect to Amazon S3.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
$sel:authentication:SMBFileShareInfo', sMBFileShareInfo_authentication - Undocumented member.
$sel:cacheAttributes:SMBFileShareInfo', sMBFileShareInfo_cacheAttributes - Refresh cache information for the file share.
$sel:objectACL:SMBFileShareInfo', sMBFileShareInfo_objectACL - Undocumented member.
$sel:kmsEncrypted:SMBFileShareInfo', sMBFileShareInfo_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
$sel:fileShareId:SMBFileShareInfo', sMBFileShareInfo_fileShareId - Undocumented member.
$sel:fileShareARN:SMBFileShareInfo', sMBFileShareInfo_fileShareARN - Undocumented member.
$sel:defaultStorageClass:SMBFileShareInfo', sMBFileShareInfo_defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by
the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING.
Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |
S3_STANDARD_IA | S3_ONEZONE_IA
$sel:fileShareName:SMBFileShareInfo', sMBFileShareInfo_fileShareName - The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in
LocationARN.
$sel:role':SMBFileShareInfo', sMBFileShareInfo_role - Undocumented member.
$sel:sMBACLEnabled:SMBFileShareInfo', sMBFileShareInfo_sMBACLEnabled - If this value is set to true, it indicates that access control list
(ACL) is enabled on the SMB file share. If it is set to false, it
indicates that file and directory permissions are mapped to the POSIX
permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
$sel:oplocksEnabled:SMBFileShareInfo', sMBFileShareInfo_oplocksEnabled - Specifies whether opportunistic locking is enabled for the SMB file
share.
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
$sel:notificationPolicy:SMBFileShareInfo', sMBFileShareInfo_notificationPolicy - The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a
client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's
best to set this parameter for as long as possible to avoid generating
multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object
uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with
SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}The following example sets NotificationPolicy off.
{}$sel:requesterPays:SMBFileShareInfo', sMBFileShareInfo_requesterPays - A value that sets who pays the cost of the request and the cost
associated with data download from the S3 bucket. If this value is set
to true, the requester pays the costs; otherwise, the S3 bucket owner
pays. However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file
share, so make sure that the configuration on the file share is the same
as the S3 bucket configuration.
Valid Values: true | false
$sel:locationARN:SMBFileShareInfo', sMBFileShareInfo_locationARN - Undocumented member.
$sel:guessMIMETypeEnabled:SMBFileShareInfo', sMBFileShareInfo_guessMIMETypeEnabled - A value that enables guessing of the MIME type for uploaded objects
based on file extensions. Set this value to true to enable MIME type
guessing, otherwise set to false. The default value is true.
Valid Values: true | false
$sel:readOnly:SMBFileShareInfo', sMBFileShareInfo_readOnly - A value that sets the write status of a file share. Set this value to
true to set the write status to read-only, otherwise set to false.
Valid Values: true | false
$sel:bucketRegion:SMBFileShareInfo', sMBFileShareInfo_bucketRegion - Specifies the Region of the S3 bucket where the SMB file share stores
files.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
$sel:caseSensitivity:SMBFileShareInfo', sMBFileShareInfo_caseSensitivity - The case of an object name in an Amazon S3 bucket. For
ClientSpecified, the client determines the case sensitivity. For
CaseSensitive, the gateway determines the case sensitivity. The
default value is ClientSpecified.
$sel:tags:SMBFileShareInfo', sMBFileShareInfo_tags - A list of up to 50 tags assigned to the SMB file share, sorted
alphabetically by key name. Each tag is a key-value pair. For a gateway
with more than 10 tags assigned, you can view all tags using the
ListTagsForResource API operation.
StorediSCSIVolume
data StorediSCSIVolume Source #
Describes an iSCSI stored volume.
See: newStorediSCSIVolume smart constructor.
Constructors
| StorediSCSIVolume' (Maybe VolumeiSCSIAttributes) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Integer) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newStorediSCSIVolume :: StorediSCSIVolume Source #
Create a value of StorediSCSIVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeiSCSIAttributes:StorediSCSIVolume', storediSCSIVolume_volumeiSCSIAttributes - An VolumeiSCSIAttributes object that represents a collection of iSCSI
attributes for one stored volume.
$sel:volumeStatus:StorediSCSIVolume', storediSCSIVolume_volumeStatus - One of the VolumeStatus values that indicates the state of the storage
volume.
$sel:sourceSnapshotId:StorediSCSIVolume', storediSCSIVolume_sourceSnapshotId - If the stored volume was created from a snapshot, this field contains
the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not
included.
$sel:preservedExistingData:StorediSCSIVolume', storediSCSIVolume_preservedExistingData - Indicates if when the stored volume was created, existing data on the
underlying local disk was preserved.
Valid Values: true | false
$sel:kmsKey:StorediSCSIVolume', storediSCSIVolume_kmsKey - Undocumented member.
$sel:volumeAttachmentStatus:StorediSCSIVolume', storediSCSIVolume_volumeAttachmentStatus - A value that indicates whether a storage volume is attached to, detached
from, or is in the process of detaching from a gateway. For more
information, see
Moving your volumes to a different gateway.
$sel:volumeARN:StorediSCSIVolume', storediSCSIVolume_volumeARN - The Amazon Resource Name (ARN) of the storage volume.
$sel:volumeProgress:StorediSCSIVolume', storediSCSIVolume_volumeProgress - Represents the percentage complete if the volume is restoring or
bootstrapping that represents the percent of data transferred. This
field does not appear in the response if the stored volume is not
restoring or bootstrapping.
$sel:volumeSizeInBytes:StorediSCSIVolume', storediSCSIVolume_volumeSizeInBytes - The size of the volume in bytes.
$sel:volumeUsedInBytes:StorediSCSIVolume', storediSCSIVolume_volumeUsedInBytes - The size of the data stored on the volume in bytes. This value is
calculated based on the number of blocks that are touched, instead of
the actual amount of data written. This value can be useful for
sequential write patterns but less accurate for random write patterns.
VolumeUsedInBytes is different from the compressed size of the volume,
which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
$sel:createdDate:StorediSCSIVolume', storediSCSIVolume_createdDate - The date the volume was created. Volumes created prior to March 28, 2017
don’t have this timestamp.
$sel:volumeId:StorediSCSIVolume', storediSCSIVolume_volumeId - The unique identifier of the volume, e.g., vol-AE4B946D.
$sel:volumeDiskId:StorediSCSIVolume', storediSCSIVolume_volumeDiskId - The ID of the local disk that was specified in the
CreateStorediSCSIVolume operation.
$sel:volumeType:StorediSCSIVolume', storediSCSIVolume_volumeType - One of the VolumeType enumeration values describing the type of the
volume.
$sel:targetName:StorediSCSIVolume', storediSCSIVolume_targetName - The name of the iSCSI target used by an initiator to connect to a volume
and used as a suffix for the target ARN. For example, specifying
TargetName as myvolume results in the target ARN of
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.
The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
Tag
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
See: newTag smart constructor.
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Network.AWS.StorageGateway.Types.Tag | |
| Hashable Tag Source # | |
Defined in Network.AWS.StorageGateway.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Network.AWS.StorageGateway.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Network.AWS.StorageGateway.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Network.AWS.StorageGateway.Types.Tag" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - Tag key. The key can't start with aws:.
$sel:value:Tag', tag_value - Value of the tag key.
Tape
Describes a virtual tape object.
See: newTape smart constructor.
Constructors
| Tape' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe POSIX) (Maybe Bool) (Maybe POSIX) |
Instances
Create a value of Tape with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeBarcode:Tape', tape_tapeBarcode - The barcode that identifies a specific virtual tape.
$sel:tapeStatus:Tape', tape_tapeStatus - The current state of the virtual tape.
$sel:kmsKey:Tape', tape_kmsKey - Undocumented member.
$sel:tapeARN:Tape', tape_tapeARN - The Amazon Resource Name (ARN) of the virtual tape.
$sel:progress:Tape', tape_progress - For archiving virtual tapes, indicates how much data remains to be
uploaded before archiving is complete.
Range: 0 (not started) to 100 (complete).
$sel:tapeSizeInBytes:Tape', tape_tapeSizeInBytes - The size, in bytes, of the virtual tape capacity.
$sel:vTLDevice:Tape', tape_vTLDevice - The virtual tape library (VTL) device that the virtual tape is
associated with.
$sel:poolId:Tape', tape_poolId - The ID of the pool that contains tapes that will be archived. The tapes
in this pool are archived in the S3 storage class that is associated
with the pool. When you use your backup application to eject the tape,
the tape is archived directly into the storage class (S3 Glacier or S3
Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
$sel:tapeUsedInBytes:Tape', tape_tapeUsedInBytes - The size, in bytes, of data stored on the virtual tape.
This value is not available for tapes created prior to May 13, 2015.
$sel:tapeCreatedDate:Tape', tape_tapeCreatedDate - The date the virtual tape was created.
$sel:poolEntryDate:Tape', tape_poolEntryDate - The date that the tape enters a custom tape pool.
$sel:worm:Tape', tape_worm - If the tape is archived as write-once-read-many (WORM), this value is
true.
$sel:retentionStartDate:Tape', tape_retentionStartDate - The date that the tape is first archived with tape retention lock
enabled.
TapeArchive
data TapeArchive Source #
Represents a virtual tape that is archived in the virtual tape shelf (VTS).
See: newTapeArchive smart constructor.
Constructors
| TapeArchive' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe POSIX) (Maybe Bool) (Maybe POSIX) (Maybe Text) |
Instances
newTapeArchive :: TapeArchive Source #
Create a value of TapeArchive with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeBarcode:TapeArchive', tapeArchive_tapeBarcode - The barcode that identifies the archived virtual tape.
$sel:tapeStatus:TapeArchive', tapeArchive_tapeStatus - The current state of the archived virtual tape.
$sel:kmsKey:TapeArchive', tapeArchive_kmsKey - Undocumented member.
$sel:tapeARN:TapeArchive', tapeArchive_tapeARN - The Amazon Resource Name (ARN) of an archived virtual tape.
$sel:tapeSizeInBytes:TapeArchive', tapeArchive_tapeSizeInBytes - The size, in bytes, of the archived virtual tape.
$sel:completionTime:TapeArchive', tapeArchive_completionTime - The time that the archiving of the virtual tape was completed.
The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
$sel:poolId:TapeArchive', tapeArchive_poolId - The ID of the pool that was used to archive the tape. The tapes in this
pool are archived in the S3 storage class that is associated with the
pool.
Valid Values: GLACIER | DEEP_ARCHIVE
$sel:tapeUsedInBytes:TapeArchive', tapeArchive_tapeUsedInBytes - The size, in bytes, of data stored on the virtual tape.
This value is not available for tapes created prior to May 13, 2015.
$sel:tapeCreatedDate:TapeArchive', tapeArchive_tapeCreatedDate - The date the virtual tape was created.
$sel:poolEntryDate:TapeArchive', tapeArchive_poolEntryDate - The time that the tape entered the custom tape pool.
The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
$sel:worm:TapeArchive', tapeArchive_worm - Set to true if the archived tape is stored as write-once-read-many
(WORM).
$sel:retentionStartDate:TapeArchive', tapeArchive_retentionStartDate - If the archived tape is subject to tape retention lock, the date that
the archived tape started being retained.
$sel:retrievedTo:TapeArchive', tapeArchive_retrievedTo - The Amazon Resource Name (ARN) of the tape gateway that the virtual tape
is being retrieved to.
The virtual tape is retrieved from the virtual tape shelf (VTS).
TapeInfo
Describes a virtual tape.
See: newTapeInfo smart constructor.
Constructors
| TapeInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe POSIX) |
Instances
newTapeInfo :: TapeInfo Source #
Create a value of TapeInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeBarcode:TapeInfo', tapeInfo_tapeBarcode - The barcode that identifies a specific virtual tape.
$sel:tapeStatus:TapeInfo', tapeInfo_tapeStatus - The status of the tape.
$sel:tapeARN:TapeInfo', tapeInfo_tapeARN - The Amazon Resource Name (ARN) of a virtual tape.
$sel:gatewayARN:TapeInfo', tapeInfo_gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and Region.
$sel:tapeSizeInBytes:TapeInfo', tapeInfo_tapeSizeInBytes - The size, in bytes, of a virtual tape.
$sel:poolId:TapeInfo', tapeInfo_poolId - The ID of the pool that you want to add your tape to for archiving. The
tape in this pool is archived in the S3 storage class that is associated
with the pool. When you use your backup application to eject the tape,
the tape is archived directly into the storage class (S3 Glacier or S3
Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
$sel:poolEntryDate:TapeInfo', tapeInfo_poolEntryDate - The date that the tape entered the custom tape pool with tape retention
lock enabled.
$sel:retentionStartDate:TapeInfo', tapeInfo_retentionStartDate - The date that the tape became subject to tape retention lock.
TapeRecoveryPointInfo
data TapeRecoveryPointInfo Source #
Describes a recovery point.
See: newTapeRecoveryPointInfo smart constructor.
Instances
newTapeRecoveryPointInfo :: TapeRecoveryPointInfo Source #
Create a value of TapeRecoveryPointInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tapeStatus:TapeRecoveryPointInfo', tapeRecoveryPointInfo_tapeStatus - The status of the virtual tapes.
$sel:tapeRecoveryPointTime:TapeRecoveryPointInfo', tapeRecoveryPointInfo_tapeRecoveryPointTime - The time when the point-in-time view of the virtual tape was replicated
for later recovery.
The default timestamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
$sel:tapeARN:TapeRecoveryPointInfo', tapeRecoveryPointInfo_tapeARN - The Amazon Resource Name (ARN) of the virtual tape.
$sel:tapeSizeInBytes:TapeRecoveryPointInfo', tapeRecoveryPointInfo_tapeSizeInBytes - The size, in bytes, of the virtual tapes to recover.
VTLDevice
Represents a device object associated with a tape gateway.
See: newVTLDevice smart constructor.
Constructors
| VTLDevice' (Maybe DeviceiSCSIAttributes) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newVTLDevice :: VTLDevice Source #
Create a value of VTLDevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceiSCSIAttributes:VTLDevice', vTLDevice_deviceiSCSIAttributes - A list of iSCSI information about a VTL device.
$sel:vTLDeviceVendor:VTLDevice', vTLDevice_vTLDeviceVendor - Specifies the vendor of the device that the VTL device object emulates.
$sel:vTLDeviceARN:VTLDevice', vTLDevice_vTLDeviceARN - Specifies the unique Amazon Resource Name (ARN) of the device (tape
drive or media changer).
$sel:vTLDeviceType:VTLDevice', vTLDevice_vTLDeviceType - Specifies the type of device that the VTL device emulates.
$sel:vTLDeviceProductIdentifier:VTLDevice', vTLDevice_vTLDeviceProductIdentifier - Specifies the model number of device that the VTL device emulates.
VolumeInfo
data VolumeInfo Source #
Describes a storage volume object.
See: newVolumeInfo smart constructor.
Constructors
| VolumeInfo' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newVolumeInfo :: VolumeInfo Source #
Create a value of VolumeInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:VolumeInfo', volumeInfo_gatewayARN - Undocumented member.
$sel:volumeAttachmentStatus:VolumeInfo', volumeInfo_volumeAttachmentStatus - One of the VolumeStatus values that indicates the state of the storage
volume.
$sel:volumeARN:VolumeInfo', volumeInfo_volumeARN - The Amazon Resource Name (ARN) for the storage volume. For example, the
following is a valid ARN:
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
$sel:volumeSizeInBytes:VolumeInfo', volumeInfo_volumeSizeInBytes - The size of the volume in bytes.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
$sel:volumeId:VolumeInfo', volumeInfo_volumeId - The unique identifier assigned to the volume. This ID becomes part of
the volume Amazon Resource Name (ARN), which you use as input for other
operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
$sel:gatewayId:VolumeInfo', volumeInfo_gatewayId - The unique identifier assigned to your gateway during activation. This
ID becomes part of the gateway Amazon Resource Name (ARN), which you use
as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
$sel:volumeType:VolumeInfo', volumeInfo_volumeType - One of the VolumeType enumeration values describing the type of the
volume.
VolumeRecoveryPointInfo
data VolumeRecoveryPointInfo Source #
Describes a storage volume recovery point object.
See: newVolumeRecoveryPointInfo smart constructor.
Instances
newVolumeRecoveryPointInfo :: VolumeRecoveryPointInfo Source #
Create a value of VolumeRecoveryPointInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeRecoveryPointTime:VolumeRecoveryPointInfo', volumeRecoveryPointInfo_volumeRecoveryPointTime - The time the recovery point was taken.
$sel:volumeARN:VolumeRecoveryPointInfo', volumeRecoveryPointInfo_volumeARN - The Amazon Resource Name (ARN) of the volume target.
$sel:volumeSizeInBytes:VolumeRecoveryPointInfo', volumeRecoveryPointInfo_volumeSizeInBytes - The size of the volume in bytes.
$sel:volumeUsageInBytes:VolumeRecoveryPointInfo', volumeRecoveryPointInfo_volumeUsageInBytes - The size of the data stored on the volume in bytes.
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
VolumeiSCSIAttributes
data VolumeiSCSIAttributes Source #
Lists iSCSI information about a volume.
See: newVolumeiSCSIAttributes smart constructor.
Constructors
| VolumeiSCSIAttributes' (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) |
Instances
newVolumeiSCSIAttributes :: VolumeiSCSIAttributes Source #
Create a value of VolumeiSCSIAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lunNumber:VolumeiSCSIAttributes', volumeiSCSIAttributes_lunNumber - The logical disk number.
$sel:targetARN:VolumeiSCSIAttributes', volumeiSCSIAttributes_targetARN - The Amazon Resource Name (ARN) of the volume target.
$sel:chapEnabled:VolumeiSCSIAttributes', volumeiSCSIAttributes_chapEnabled - Indicates whether mutual CHAP is enabled for the iSCSI target.
$sel:networkInterfaceId:VolumeiSCSIAttributes', volumeiSCSIAttributes_networkInterfaceId - The network interface identifier.
$sel:networkInterfacePort:VolumeiSCSIAttributes', volumeiSCSIAttributes_networkInterfacePort - The port used to communicate with iSCSI targets.